Nimbalyst

https://docs.nimbalyst.com/
Admin
Nimbalyst is a free, local WYSIWYG file editor and session/task manager for iterating with AI coding...
Tokens:54,974
Snippets:706
Trust Score:7.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install Nim CLI

Source: https://docs.nimbalyst.com/task-management/nim-cli.md

Install the nim CLI globally via npm.

```bash
npm install -g @nimbalyst/cli
```

--------------------------------

### Complete Extension Manifest Example

Source: https://docs.nimbalyst.com/extensions/building-extensions/manifest-reference.md

A comprehensive example of a manifest file defining metadata, permissions, and various contribution points.

```json
{
  "id": "com.nimbalyst.csv-tools",
  "name": "CSV Tools",
  "version": "1.0.0",
  "description": "Custom CSV editing and AI helpers",
  "author": "Nimbalyst",
  "main": "dist/index.js",
  "styles": "dist/index.css",
  "apiVersion": "1.0.0",
  "defaultEnabled": true,
  "permissions": {
    "filesystem": true,
    "ai": true
  },
  "contributions": {
    "customEditors": [
      {
        "filePatterns": ["*.csv", "*.tsv"],
        "displayName": "Spreadsheet Editor",
        "component": "SpreadsheetEditor",
        "supportsSourceMode": true
      }
    ],
    "aiTools": [
      "csv.get_schema",
      "csv.query"
    ],
    "fileIcons": {
      "*.csv": "table",
      "*.tsv": "table"
    },
    "slashCommands": [
      {
        "id": "csv.insert-table",
        "title": "Insert CSV Table",
        "handler": "insertCsvTable"
      }
    ],
    "configuration": {
      "properties": {
        "delimiter": {
          "type": "string",
          "default": ","
        }
      }
    }
  }
}
```

--------------------------------

### Install Extension Dependencies

Source: https://docs.nimbalyst.com/extensions/building-extensions/getting-started.md

Install the required development tools and runtime dependencies for a Nimbalyst extension.

```bash
npm install --save-dev typescript vite @nimbalyst/extension-sdk
npm install react
```

--------------------------------

### GET /getting-started/readme.md

Source: https://docs.nimbalyst.com/getting-started/readme.md

Queries the documentation for information by providing a question and an optional goal.

```APIDOC
## GET /getting-started/readme.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/getting-started/readme.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /getting-started/quickstart.md

Source: https://docs.nimbalyst.com/getting-started/quickstart.md

Perform a query against the documentation to receive a direct answer and relevant excerpts.

```APIDOC
## GET /getting-started/quickstart.md

### Description
Queries the documentation dynamically to retrieve an answer based on a specific question and an optional end goal.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/getting-started/quickstart.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nimbalyst.com/developer-features/basics-on-code-git-for-non-devs.md

Perform a GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve context-aware answers.

```http
GET https://docs.nimbalyst.com/developer-features/basics-on-code-git-for-non-devs.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Install GitHub Copilot CLI

Source: https://docs.nimbalyst.com/setup-nimbalyst/ai-provider-setup-and-notifications.md

Command to install the GitHub Copilot CLI globally via npm for agent integration.

```bash
npm install -g @github/copilot
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nimbalyst.com/detailed-install-guides

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve context-aware answers.

```http
GET https://docs.nimbalyst.com/detailed-install-guides.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /task-management/overview.md

Source: https://docs.nimbalyst.com/task-management/overview.md

Queries the documentation dynamically by providing a question and an optional goal.

```APIDOC
## GET /task-management/overview.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/overview.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /detailed-install-guides.md

Source: https://docs.nimbalyst.com/detailed-install-guides

Queries the documentation for specific information by providing a question and an optional goal context.

```APIDOC
## GET /detailed-install-guides.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/detailed-install-guides.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /setup-nimbalyst/mcp.md

Source: https://docs.nimbalyst.com/setup-nimbalyst/mcp.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /setup-nimbalyst/mcp.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/setup-nimbalyst/mcp.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /detailed-install-guides/mac-detailed-install-guide.md

Source: https://docs.nimbalyst.com/detailed-install-guides/mac-detailed-install-guide.md

Queries the documentation page for specific information by providing a question and an optional goal.

```APIDOC
## GET /detailed-install-guides/mac-detailed-install-guide.md

### Description
Queries the documentation page dynamically to retrieve answers, excerpts, or context based on a specific question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/detailed-install-guides/mac-detailed-install-guide.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /getting-started.md

Source: https://docs.nimbalyst.com/getting-started

Queries the documentation dynamically by providing a question and an optional goal to receive a contextual answer.

```APIDOC
## GET /getting-started.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/getting-started.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /extensions/building-extensions/api-reference.md

Source: https://docs.nimbalyst.com/extensions/building-extensions/api-reference.md

Queries the documentation dynamically by asking a question.

```APIDOC
## GET /extensions/building-extensions/api-reference.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/extensions/building-extensions/api-reference.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific question to ask.
- **goal** (string) - Optional - The broader end goal to tailor the answer.
```

--------------------------------

### GET /task-management/creating-items.md

Source: https://docs.nimbalyst.com/task-management/creating-items.md

Query the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /task-management/creating-items.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or clarification is needed.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/creating-items.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /getting-started/nimbalyst-demo-and-use-cases.md

Source: https://docs.nimbalyst.com/getting-started/nimbalyst-demo-and-use-cases.md

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored answer.

```APIDOC
## GET /getting-started/nimbalyst-demo-and-use-cases.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the page. The response provides a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/getting-started/nimbalyst-demo-and-use-cases.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /setup-nimbalyst/voice-mode.md

Source: https://docs.nimbalyst.com/setup-nimbalyst/voice-mode.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /setup-nimbalyst/voice-mode.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/setup-nimbalyst/voice-mode.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /extensions/extension-system-and-marketplace.md

Source: https://docs.nimbalyst.com/extensions/extension-system-and-marketplace.md

Queries the documentation dynamically by providing a specific question and an optional goal.

```APIDOC
## GET https://docs.nimbalyst.com/extensions/extension-system-and-marketplace.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/extensions/extension-system-and-marketplace.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
- The response contains a direct answer to the question along with relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /getting-started/feedback-discord-support-releases.md

Source: https://docs.nimbalyst.com/getting-started/feedback-discord-support-releases.md

Performs a dynamic query against the documentation page to retrieve answers or context based on a specific question.

```APIDOC
## GET /getting-started/feedback-discord-support-releases.md

### Description
Performs an HTTP GET request on the current page URL to query the documentation dynamically. This is used when specific information is not directly available in the page content.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/getting-started/feedback-discord-support-releases.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /troubleshooting.md

Source: https://docs.nimbalyst.com/troubleshooting

Performs a dynamic query against the documentation to retrieve answers and relevant excerpts.

```APIDOC
## GET /troubleshooting.md

### Description
Performs a dynamic query against the documentation to retrieve answers and relevant excerpts based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/troubleshooting.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Request Example
GET https://docs.nimbalyst.com/troubleshooting.md?ask=How+do+I+reset+my+password?&goal=account+recovery
```

--------------------------------

### GET /extensions/building-extensions/ai-tools.md

Source: https://docs.nimbalyst.com/extensions/building-extensions/ai-tools.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /extensions/building-extensions/ai-tools.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a natural language question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/extensions/building-extensions/ai-tools.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### GET /task-management/local-config.md

Source: https://docs.nimbalyst.com/task-management/local-config.md

Queries the documentation dynamically by asking a question related to the current page content.

```APIDOC
## GET /task-management/local-config.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or clarification is needed.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/local-config.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question with relevant excerpts and sources.
```

--------------------------------

### GET /troubleshooting/troubleshooting.md

Source: https://docs.nimbalyst.com/troubleshooting/troubleshooting.md

Queries the documentation dynamically by providing a question and an optional goal to receive a contextual answer.

```APIDOC
## GET /troubleshooting/troubleshooting.md

### Description
Performs a dynamic query against the documentation to retrieve information not explicitly covered in the current page. The response provides a direct answer along with relevant excerpts and sources.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/troubleshooting/troubleshooting.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask in natural language.
- **goal** (string) - Optional - The broader end goal the user is trying to accomplish, used to tailor the response.
```

--------------------------------

### GET /extensions/building-extensions.md

Source: https://docs.nimbalyst.com/extensions/building-extensions.md

Perform a dynamic query against the documentation page to retrieve answers and relevant excerpts.

```APIDOC
## GET /extensions/building-extensions.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present on the page or to get clarification.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/extensions/building-extensions.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP

Source: https://docs.nimbalyst.com/extensions/building-extensions/getting-started.md

Perform an HTTP GET request to retrieve information from the documentation dynamically.

```http
GET https://docs.nimbalyst.com/extensions/building-extensions/getting-started.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /task-management.md

Source: https://docs.nimbalyst.com/task-management

Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response.

```APIDOC
## GET /task-management.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and an optional broader goal.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts from the documentation.
- **sources** (array) - Sources used to generate the answer.
```

--------------------------------

### GET /file-management/share-link-to-a-file.md

Source: https://docs.nimbalyst.com/file-management/share-link-to-a-file.md

Query the documentation dynamically by performing an HTTP GET request on the page URL.

```APIDOC
## GET /file-management/share-link-to-a-file.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or further clarification is needed.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/file-management/share-link-to-a-file.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /visual-editors-powered-by-ai/excalidraw.md

Source: https://docs.nimbalyst.com/visual-editors-powered-by-ai/excalidraw.md

Perform an HTTP GET request on the documentation page URL to query information dynamically.

```APIDOC
## GET /visual-editors-powered-by-ai/excalidraw.md

### Description
Query the documentation dynamically by asking a question to retrieve information, excerpts, and sources.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/visual-editors-powered-by-ai/excalidraw.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to tailor the answer.
```

--------------------------------

### Initialize Extension Project

Source: https://docs.nimbalyst.com/extensions/building-extensions/getting-started.md

Create a new directory and initialize a Node.js project for the extension.

```bash
mkdir my-first-extension
cd my-first-extension
npm init -y
```

--------------------------------

### GET /detailed-install-guides/windows-detailed-install-guide.md

Source: https://docs.nimbalyst.com/detailed-install-guides/windows-detailed-install-guide.md

Queries the documentation page for specific information using a natural language question and an optional goal context.

```APIDOC
## GET /detailed-install-guides/windows-detailed-install-guide.md

### Description
Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/detailed-install-guides/windows-detailed-install-guide.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained natural language question.
- **goal** (string) - Optional - The broader end goal to help tailor the response.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant documentation excerpts and sources.
```

--------------------------------

### GET /task-management/referencing-tracker-items.md

Source: https://docs.nimbalyst.com/task-management/referencing-tracker-items.md

Perform an HTTP GET request on the documentation page URL to retrieve answers to specific questions based on the content.

```APIDOC
## GET /task-management/referencing-tracker-items.md

### Description
Queries the documentation dynamically to receive a direct answer, relevant excerpts, and sources based on the provided question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/referencing-tracker-items.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate, specific question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /task-management/ai-integration.md

Source: https://docs.nimbalyst.com/task-management/ai-integration.md

Perform an HTTP GET request on the documentation page to retrieve answers to specific questions based on the documentation content.

```APIDOC
## GET /task-management/ai-integration.md

### Description
Query the documentation dynamically by asking a question to receive a direct answer and relevant excerpts.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/ai-integration.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /session-management/import-claude-code-sessions.md

Source: https://docs.nimbalyst.com/session-management/import-claude-code-sessions.md

Perform an HTTP GET request on the documentation page URL to query information dynamically using natural language.

```APIDOC
## GET /session-management/import-claude-code-sessions.md

### Description
Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored answer with relevant excerpts.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/session-management/import-claude-code-sessions.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /setup-nimbalyst/ai-provider-setup-and-notifications.md

Source: https://docs.nimbalyst.com/setup-nimbalyst/ai-provider-setup-and-notifications.md

Queries the documentation dynamically by providing a specific question and an optional end goal to receive a tailored response.

```APIDOC
## GET /setup-nimbalyst/ai-provider-setup-and-notifications.md

### Description
Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a provided question and optional goal.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/setup-nimbalyst/ai-provider-setup-and-notifications.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Define main entry point

Source: https://docs.nimbalyst.com/extensions/building-extensions/manifest-reference.md

Path to the JavaScript entry point relative to the manifest file.

```json
"main": "dist/index.js"
```

--------------------------------

### GET /task-management/commits-and-sessions.md

Source: https://docs.nimbalyst.com/task-management/commits-and-sessions.md

Perform a query against the documentation to retrieve information or clarifications.

```APIDOC
## GET /task-management/commits-and-sessions.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/commits-and-sessions.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /open-safe-private-secure/session-and-window-state-storage.md

Source: https://docs.nimbalyst.com/open-safe-private-secure/session-and-window-state-storage.md

Performs a natural language query against the documentation content.

```APIDOC
## GET /open-safe-private-secure/session-and-window-state-storage.md

### Description
Queries the documentation dynamically by asking a question related to the content.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/open-safe-private-secure/session-and-window-state-storage.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.
```

--------------------------------

### GET /visual-editors-powered-by-ai/data-models.md

Source: https://docs.nimbalyst.com/visual-editors-powered-by-ai/data-models.md

Perform a query against the documentation to retrieve information or context-aware answers.

```APIDOC
## GET /visual-editors-powered-by-ai/data-models.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/visual-editors-powered-by-ai/data-models.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **response** (string) - Contains a direct answer to the question and relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /task-management/sharing-plans-and-trackers.md

Source: https://docs.nimbalyst.com/task-management/sharing-plans-and-trackers.md

Queries the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /task-management/sharing-plans-and-trackers.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/sharing-plans-and-trackers.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Query Documentation via HTTP

Source: https://docs.nimbalyst.com/developer-features/turn-on-off-developer-mode.md

Use this request to ask questions about the documentation dynamically. The ask parameter is required, while the goal parameter is optional for context.

```http
GET https://docs.nimbalyst.com/developer-features/turn-on-off-developer-mode.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Query Documentation via HTTP

Source: https://docs.nimbalyst.com/developer-features/agent-teams-and-super-loops.md

Perform an HTTP GET request to the documentation URL with 'ask' and 'goal' parameters to retrieve context-aware answers.

```http
GET https://docs.nimbalyst.com/developer-features/agent-teams-and-super-loops.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /task-management/linking-tracker-items.md

Source: https://docs.nimbalyst.com/task-management/linking-tracker-items.md

Queries the documentation dynamically by asking a question related to the content.

```APIDOC
## GET /task-management/linking-tracker-items.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/linking-tracker-items.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - The direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### Query Documentation via HTTP GET

Source: https://docs.nimbalyst.com/developer-features

Perform a dynamic query against the documentation by appending ask and goal parameters to the page URL.

```http
GET https://docs.nimbalyst.com/developer-features.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### Implement the extension entry point

Source: https://docs.nimbalyst.com/extensions/building-extensions/getting-started.md

The src/index.ts file exports components referenced in the manifest and provides lifecycle hooks for activation and deactivation.

```typescript
import type { ExtensionContext } from '@nimbalyst/extension-sdk';
import { HelloEditor } from './HelloEditor';

// Export components that the manifest references
export const components = {
  HelloEditor,
};

// Called when the extension is loaded
export function activate(context: ExtensionContext) {
  console.log('Hello Editor extension activated!');
}

// Called when the extension is unloaded
export function deactivate() {
  console.log('Hello Editor extension deactivated');
}
```

--------------------------------

### Create Automation via Command

Source: https://docs.nimbalyst.com/session-management/automations.md

Use the slash command to generate an automation file template based on a natural language description.

```text
/automation summarize my git commits every weekday morning
```

--------------------------------

### GET /session-management/share-link-to-a-session.md

Source: https://docs.nimbalyst.com/session-management/share-link-to-a-session.md

Perform a query against the documentation to retrieve information or clarification regarding the content.

```APIDOC
## GET /session-management/share-link-to-a-session.md

### Description
Perform an HTTP GET request on the documentation page URL to query for information not explicitly present in the page.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/session-management/share-link-to-a-session.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### GET /setup-nimbalyst.md

Source: https://docs.nimbalyst.com/setup-nimbalyst

Perform a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

```APIDOC
## GET /setup-nimbalyst.md

### Description
Queries the documentation dynamically to retrieve information not explicitly present in the current page.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/setup-nimbalyst.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask in natural language.
- **goal** (string) - Optional - The broader end goal to help tailor the response context.
```

--------------------------------

### Import Mermaid Syntax

Source: https://docs.nimbalyst.com/visual-editors-powered-by-ai/excalidraw.md

Example of Mermaid syntax used to generate visual diagrams within the Excalidraw editor.

```mermaid
graph TD
    A[Start] --> B{Decision}
    B -->|Yes| C[Action]
    B -->|No| D[End]
```

--------------------------------

### GET /session-management/agent-window-and-session-management.md

Source: https://docs.nimbalyst.com/session-management/agent-window-and-session-management.md

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /session-management/agent-window-and-session-management.md

### Description
Queries the documentation dynamically to retrieve an answer and relevant excerpts based on a provided question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/session-management/agent-window-and-session-management.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to be answered.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /mobile.md

Source: https://docs.nimbalyst.com/mobile

Queries the documentation for specific information by providing a question and an optional goal.

```APIDOC
## GET /mobile.md

### Description
Perform a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a specific question and optional goal.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/mobile.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Query Documentation via HTTP

Source: https://docs.nimbalyst.com/developer-features/terminal-window.md

Perform an HTTP GET request to the documentation URL to retrieve answers to specific questions using the ask and goal parameters.

```http
GET https://docs.nimbalyst.com/developer-features/terminal-window.md?ask=<question>&goal=<endgoal>
```

--------------------------------

### GET /file-management/file-edits-sidebar.md

Source: https://docs.nimbalyst.com/file-management/file-edits-sidebar.md

Performs a dynamic query against the documentation page to retrieve information or clarification.

```APIDOC
## GET /file-management/file-edits-sidebar.md

### Description
Queries the documentation dynamically by asking a question related to the content. This is useful for retrieving information not explicitly present on the page or for gaining additional context.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/file-management/file-edits-sidebar.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the response.
```

--------------------------------

### GET /visual-editors-powered-by-ai/pdf-viewer.md

Source: https://docs.nimbalyst.com/visual-editors-powered-by-ai/pdf-viewer.md

Queries the documentation dynamically to retrieve information not explicitly covered in the current page.

```APIDOC
## GET /visual-editors-powered-by-ai/pdf-viewer.md

### Description
Performs a query against the documentation to retrieve answers, excerpts, or context related to a specific question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/visual-editors-powered-by-ai/pdf-viewer.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /visual-editors-powered-by-ai/csv.md

Source: https://docs.nimbalyst.com/visual-editors-powered-by-ai/csv.md

Queries the documentation dynamically by providing a specific question and an optional broader goal.

```APIDOC
## GET /visual-editors-powered-by-ai/csv.md

### Description
Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or requires clarification.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/visual-editors-powered-by-ai/csv.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask, written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.

### Response
#### Success Response (200)
- **answer** (string) - A direct answer to the question.
- **excerpts** (array) - Relevant excerpts and sources from the documentation.
```

--------------------------------

### GET /extensions/building-extensions/manifest-reference.md

Source: https://docs.nimbalyst.com/extensions/building-extensions/manifest-reference.md

Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant sources.

```APIDOC
## GET /extensions/building-extensions/manifest-reference.md

### Description
Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored answer with relevant sources.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/extensions/building-extensions/manifest-reference.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask the documentation.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /task-management/item-types-and-fields.md

Source: https://docs.nimbalyst.com/task-management/item-types-and-fields.md

Perform a dynamic query against the documentation page to retrieve specific information or context.

```APIDOC
## GET /task-management/item-types-and-fields.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, or context related to the provided question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/task-management/item-types-and-fields.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### GET /session-management/interactive-prompts.md

Source: https://docs.nimbalyst.com/session-management/interactive-prompts.md

Queries the documentation for information by providing a natural language question and an optional goal.

```APIDOC
## GET /session-management/interactive-prompts.md

### Description
Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/session-management/interactive-prompts.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question written in natural language.
- **goal** (string) - Optional - Describes the broader end goal to help tailor the answer.
```

--------------------------------

### Define extension styles

Source: https://docs.nimbalyst.com/extensions/building-extensions/manifest-reference.md

Path to the CSS bundle file.

```json
"styles": "dist/index.css"
```

--------------------------------

### Define extension commands

Source: https://docs.nimbalyst.com/extensions/building-extensions/manifest-reference.md

Register general commands with optional keybindings.

```json
"commands": [
  {
    "id": "csv.refresh",
    "title": "Refresh CSV Data",
    "keybinding": "CmdOrCtrl+Shift+R"
  }
]
```

--------------------------------

### GET /session-management/ai-actions.md

Source: https://docs.nimbalyst.com/session-management/ai-actions.md

Queries the documentation for information by providing a specific question and an optional end goal.

```APIDOC
## GET /session-management/ai-actions.md

### Description
Perform a query against the documentation to retrieve answers, excerpts, and sources based on a specific question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/session-management/ai-actions.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The immediate question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```

--------------------------------

### Implement a Simple Table Editor

Source: https://docs.nimbalyst.com/extensions/building-extensions/custom-editors.md

Demonstrates a complete editor implementation using useEditorLifecycle for state management and content serialization.

```tsx
import React, { useRef } from 'react';
import { useEditorLifecycle } from '@nimbalyst/extension-sdk';
import type { EditorHostProps } from '@nimbalyst/extension-sdk';

export function TableEditor({ host }: EditorHostProps) {
  const dataRef = useRef<string[][]>([]);
  const tableRef = useRef<HTMLTableElement>(null);

  const parseCSV = (text: string): string[][] =>
    text.split('\n').map(row => row.split(',').map(cell => cell.trim()));

  const serializeCSV = (data: string[][]): string =>
    data.map(row => row.join(',')).join('\n');

  const { isLoading, error, theme, markDirty } = useEditorLifecycle(host, {
    applyContent: (data: string[][]) => {
      dataRef.current = data;
      renderTable();
    },
    getCurrentContent: () => dataRef.current,
    parse: parseCSV,
    serialize: serializeCSV,
  });

  function renderTable() {
    // Re-render table imperatively or use forceUpdate
  }

  if (error) return <div>Error: {error.message}</div>;
  if (isLoading) return <div>Loading...</div>;

  return (
    <div style={{ padding: '10px', overflow: 'auto', height: '100%' }}>
      <table ref={tableRef} style={{ borderCollapse: 'collapse', width: '100%' }}>
        <tbody>
          {dataRef.current.map((row, rowIndex) => (
            <tr key={rowIndex}>
              {row.map((cell, colIndex) => (
                <td key={colIndex} style={{ border: '1px solid var(--nim-border)' }}>
                  <input
                    defaultValue={cell}
                    onChange={e => {
                      dataRef.current[rowIndex][colIndex] = e.target.value;
                      markDirty();
                    }}
                    style={{
                      width: '100%',
                      padding: '4px',
                      border: 'none',
                      background: 'transparent',
                      color: 'var(--nim-text)'
                    }}
                  />
                </td>
              ))}
            </tr>
          ))}
        </tbody>
      </table>
    </div>
  );
}
```

--------------------------------

### GET /developer-features/working-with-git.md

Source: https://docs.nimbalyst.com/developer-features/working-with-git.md

Queries the documentation for specific information by providing a question and an optional end goal.

```APIDOC
## GET /developer-features/working-with-git.md

### Description
Performs a dynamic query against the documentation to retrieve answers, excerpts, and sources based on a provided question.

### Method
GET

### Endpoint
https://docs.nimbalyst.com/developer-features/working-with-git.md

### Parameters
#### Query Parameters
- **ask** (string) - Required - The specific, self-contained question to ask.
- **goal** (string) - Optional - The broader end goal to help tailor the response.
```
Tokens:
Raw