Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 32 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Mintlify Starter Kit

Click on `Use this template` to copy the Mintlify starter kit. The starter kit contains examples including

- Guide pages
- Navigation
- Customizations
- API Reference pages
- Use of popular components

### Development

Install the [Mintlify CLI](https://www.npmjs.com/package/mintlify) to preview the documentation changes locally. To install, use the following command

```
npm i -g mintlify
```

Run the following command at the root of your documentation (where docs.json is)

```
mintlify dev
```

### Publishing Changes

Install our Github App to auto propagate changes from your repo to your deployment. Changes will be deployed to production automatically after pushing to the default branch. Find the link to install on your dashboard.

#### Troubleshooting

- Mintlify dev isn't running - Run `mintlify install` it'll re-install dependencies.
- Page loads as a 404 - Make sure you are running in a folder with `docs.json`
28 changes: 28 additions & 0 deletions docs/api-reference/functions/prompt-with.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: 'PROMPTWITH'
---

```excel
PROMPTWITH(providerAndModel: string or cell, cells: range | instruction: string, [instruction: range or string | temperature: double], [temperature: double]): string
```

Allows you to call a model from a cell formula and specify the model as the first argument. This overides the default model.

- **providerAndModel (Required)**: A string on the form "provider/model".
- Default: ollama/gemma2:2b
- **cells (Required):** A cell or a range of cells.
- The model will use the cells as context and follow any instructions as long as they are present _somewhere_ in the cells. If you provide an instruction as second argument, the second argument instructions takes precedence.
- **instructions (Optional):** A cell, a range of cells, or a string.
- The model will follow these instructions and ignore instructions in the cells of the first argument.
- Default: Empty.
- **temperature (Optional):** double.
- A value between 0 and 1 that controls the balance between deterministic outputs and creative exploration. Lower values make the output more deterministic, higher values make it more random.
- Default: 0. The model will almost always give you the same result.
- **Returns:** The AI model's response as plain text.

Example usage:

- `=PROMPT("openai/gpt-4o-mini", A1:D10, "Extract keywords")` will use GPT-4o mini to extract keywords from the cells.
- `=PROMPT("openai/gpt-4o-mini", A1:D10, "Extract keywords", 0.7)` will use GPT-4o minito extract keywords from the cells and use a temperature of 0.7.
- `=PROMPT("openai/gpt-4o-mini", A1:D10)` will use GPT-4o mini to process the range of cells and follow instructions as long as they present _somewhere_ in the cells.
- `=PROMPT("openai/gpt-4o-mini", A1:D10, 0.7)` will use GPT-4o mini to process the selected range of cells, follow any instruction within the cells, and use a temperature of 0.7.
27 changes: 27 additions & 0 deletions docs/api-reference/functions/prompt.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: 'PROMPT'
---

```excel
PROMPT(cells: range | instruction: string, [instruction: range or string | temperature: double], [temperature: double]): string
```

Allows you to call a model from a cell formula.

- **cells (Required):** A cell or a range of cells.
- The model will use the cells as context and follow any instructions as long as they are present _somewhere_ in the cells. If you provide an instruction as second argument, the second argument instructions takes precedence.
- **instructions (Optional):** A cell, a range of cells, or a string.
- The model will follow these instructions and ignore instructions in the cells of the first argument.
- Default: Empty.
- **temperature (Optional):** double.
- A value between 0 and 1 that controls the balance between deterministic outputs and creative exploration. Lower values make the output more deterministic, higher values make it more random.
- Default: 0. The model will almost always give you the same result.
- **Returns:** string.
- The AI model's response.

Example usage:

- `=PROMPT(A1:D10, "Extract keywords")` will use the selected range of cells as context and follow the instruction to extract keywords.
- `=PROMPT(A1:D10, "Extract keywords", 0.7)` will use the selected range of cells as context, follow the instruction to extract keywords, and use a temperature of 0.7.
- `=PROMPT(A1:D10)` will use the range of cells as context and follow instructions as long as they present _somewhere_ in the cells.
- `=PROMPT(A1:D10, 0.7)` will use the selected range of cells as context, follow any instruction within the cells, and use a temperature of 0.7.
17 changes: 17 additions & 0 deletions docs/api-reference/tools/file-reader.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: 'File Reader'
---

Reads a file and returns its content as plain text.

```csharp
FileReader(filePath: string)
```

- **filePath (Required):** A path to a file on your disk.
- Supports extensions c, cpp, cs, csv, cxx, h, hxx, html, java, json, jsonl, md, pdf, php, py, rb, txt, and xml.
- **Returns:** The content of the file as plain text.

<Warning>
You cannot call this function yourself, but you can instruct the model to call it for you.
</Warning>
21 changes: 21 additions & 0 deletions docs/api-reference/tools/file-search.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
---
title: 'File Search'
---

Uses glob patterns to search for files on the your disk and returns matching file paths.

```csharp
FileReader(rootPath: string, includePatterns: [string], [excludePatterns: [string]])
```

- **rootPath (Required):** A string.
- The root directory to start the glob search from.
- **includePatterns (Required):** List of strings.
- The list of glob patterns whose matches will be included in the result.
- **excludePatterns (Optional):** List of strings.
- A list of glob patterns whose matches will be excluded from the result.
- Default: Empty.

<Warning>
You cannot call this function yourself, but you can instruct the model to call it for you.
</Warning>
104 changes: 104 additions & 0 deletions docs/docs.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "mint",
"name": "Cellm",
"colors": {
"primary": "#107C42",
"light": "#33C480",
"dark": "#185C37"
},
"favicon": "/favicon.svg",
"navigation": {
"tabs": [
{
"tab": "Guides",
"groups": [
{
"group": "Get Started",
"pages": [
"get-started/overview",
"get-started/quickstart",
"get-started/install",
"get-started/development"
]
},
{
"group": "Usage",
"pages": [
"usage/prompting",
"usage/function-calling"
]
},
{
"group": "Models",
"pages": [
"models/local-models",
"models/hosted-models"
]
}
]
},
{
"tab": "API Reference",
"groups": [
{
"group": "Functions",
"pages": [
"api-reference/functions/prompt",
"api-reference/functions/prompt-with"
]
},
{
"group": "Tools",
"pages": [
"api-reference/tools/file-search",
"api-reference/tools/file-reader"
]
}
]
}
],
"global": {
"anchors": [
{
"anchor": "Homepage",
"href": "https://docs.getcellm.com",
"icon": "house"
},
{
"anchor": "Github",
"href": "https://getcellm.com/getcellm/cellm",
"icon": "github"
},
{
"anchor": "Discord",
"href": "https://discord.gg/zApxYpe2ZW",
"icon": "discord"
}
]
}
},
"logo": {
"light": "/logo/light.svg",
"dark": "/logo/dark.svg"
},
"navbar": {
"links": [
{
"label": "Github",
"href": "https://getcellm.com/getcellm/cellm"
}
],
"primary": {
"type": "button",
"label": "Support",
"href": "https://github.com/getcellm/cellm/issues"
}
},
"footer": {
"socials": {
"github": "https://github.com/getcellm/cellm",
"discord": "https://discord.gg/zApxYpe2ZW"
}
}
}
5 changes: 5 additions & 0 deletions docs/favicon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
72 changes: 72 additions & 0 deletions docs/get-started/development.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
---
title: 'Development'
description: 'Get started with Cellm development and contributions'
icon: 'code'
---

## Build with command line

1. Clone this repository:
```cmd
git clone https://github.com/getcellm/cellm.git
```

2. In your terminal, go into the root of the project directory:
```cmd
cd cellm
```

3. Install dependencies:
```cmd
dotnet restore
```

4. Build the project:
```cmd
dotnet build --configuration Debug
```

## Build with Visual Studio

1. In Visual Studio, go to File > Clone Repository.

2. Set the Repository Location to `https://github.com/getcellm/cellm`, the Path to a directory of your choice, and click Clone.

3. Run the "Excel" configuration. Visual Studio will build Cellm and open Excel. Click on "Enable this add-in for this session only" to load the build into Excel.

## Debug with Visual Studio

All Visual Studio's usual debugging tools works when you run the "Excel" configuration. You can set breakpoints, inspect runtime variables, and view log messages in the Output window. To exercise code, type e.g. `=PROMPT("Hello World")` in a cell's formula and run it.

## Contributing

We welcome contributions to Cellm! This section will guide you through the process.

1. Fork the repository on GitHub
2. Create a new branch from `main` for your feature or bug fix:
```cmd
git checkout -b your-feature-name
```
3. Make your changes.
4. Commit your changes with clear, descriptive commit messages with [Conventional Commits](https://gist.github.com/qoomon/5dfcdf8eec66a051ecd85625518cfd13) prefixes (fix, feat, docs, refactor):
```cmd
git commit -m "feat: descriptive message"
```
5. Push your branch to your fork:
```cmd
git push origin your-feature-name
```
6. Open a Pull Request (PR) against our `main` branch

### Contributor License Agreement (CLA)

You must sign our [Contributor License Agreement (CLA)](https://github.com/getcellm/cellm/blob/main/CLA.md). This is a one-time requirement that grants us the necessary rights to use your contributions. The CLA signing process will be automatically initiated when you submit your first PR. Our bot will guide you through the process.

### Getting Help

If you have questions about contributing:
- Open a GitHub issue for bug reports or feature discussions
- Check existing issues and PRs to avoid duplicates
- Join our community discussions in [Discord](https://discord.gg/zApxYpe2ZW) for general questions

We review all PRs.
Loading