### German Documentation - Getting Started Source: https://docs.cursor.com/ko/chat/agent Getting started guide in German, covering installation and basic concepts. ```APIDOC ## German Documentation - Getting Started ### Description Initial setup and introductory information for German-speaking users. ### Endpoints - `de/welcome` - `de/get-started/installation` - `de/get-started/quickstart` - `de/get-started/concepts` ``` -------------------------------- ### CLI - Getting Started Source: https://docs.cursor.com/id/account/pricing Guides for getting started with the Cursor CLI, including overview, installation, and usage. ```APIDOC ## CLI Overview ### Description An overview of the Cursor Command Line Interface. ### Method GET ### Endpoint /de/cli/overview ## CLI Installation ### Description Instructions for installing the Cursor CLI. ### Method GET ### Endpoint /de/cli/installation ## Using the CLI ### Description Guides on how to use the Cursor CLI effectively. ### Method GET ### Endpoint /de/cli/using ## CLI MCP ### Description Information on using Mentioned Code Parts (MCP) with the CLI. ### Method GET ### Endpoint /de/cli/mcp ## CLI Shell Mode ### Description Details on using the CLI in shell mode. ### Method GET ### Endpoint /de/cli/shell-mode ``` -------------------------------- ### CLI - Overview and Installation Source: https://docs.cursor.com/de/account/teams/sso Getting started with the Cursor CLI, including an overview and installation instructions. ```APIDOC ## CLI Overview ### Description An overview of the Cursor Command Line Interface. ### Endpoint `/de/cli/overview` ## CLI Installation ### Description Instructions for installing the Cursor CLI. ### Endpoint `/de/cli/installation` ## Using the CLI ### Description Guide on how to use the Cursor CLI. ### Endpoint `/de/cli/using` ## CLI MCP (Most Constrained Path) ### Description Information on using MCP with the CLI. ### Endpoint `/de/cli/mcp` ## CLI Shell Mode ### Description Information on operating the CLI in shell mode. ### Endpoint `/de/cli/shell-mode` ``` -------------------------------- ### CLI Overview Source: https://docs.cursor.com/pt-BR/agent/overview Getting started with the Cursor CLI, including installation and basic usage. ```APIDOC ## CLI Overview ### Description An overview of the Cursor Command Line Interface. ### Endpoint `/de/cli/overview` --- ## CLI Installation ### Description Instructions for installing the Cursor CLI. ### Endpoint `/de/cli/installation` --- ## CLI Using ### Description Guide on how to use the Cursor CLI. ### Endpoint `/de/cli/using` --- ## CLI MCP ### Description Using MCP (Most Constrained Path) with the CLI. ### Endpoint `/de/cli/mcp` --- ## CLI Shell Mode ### Description Information about the shell mode in the CLI. ### Endpoint `/de/cli/shell-mode` ``` -------------------------------- ### German Documentation: Get Started Source: https://docs.cursor.com/zh/guides Getting started guide for Cursor in German. ```APIDOC ## German Documentation: Get Started ### Description This section provides guidance on installation, quick start, and core concepts for new users in German. ### Method N/A (Documentation Section) ### Endpoint N/A (Documentation Section) ### Parameters N/A ### Request Example N/A ### Response N/A ``` -------------------------------- ### German Documentation - Welcome & Get Started Source: https://docs.cursor.com/ko/guides/tutorials/web-development German language documentation covering the welcome guide and initial setup steps for Cursor IDE. ```APIDOC ## German Documentation - Welcome & Get Started ### Description This section provides the initial documentation in German, including a welcome message and instructions for getting started with Cursor IDE. ### Welcome - **Welcome**: `de/welcome` ### Get Started - **Installation**: `de/get-started/installation` - **Quickstart**: `de/get-started/quickstart` - **Concepts**: `de/get-started/concepts` ``` -------------------------------- ### Clone Example Project with Git Source: https://docs.cursor.com/de/get-started/quickstart This snippet demonstrates how to clone the example project repository using Git and then navigate into the project directory. It assumes Git is installed and ready for use. ```shellscript git clone git@github.com:voxelize/voxelize.git && cd voxelize && cursor . ``` -------------------------------- ### Shell Script: Clone and Navigate Example Repository Source: https://docs.cursor.com/zh/get-started/quickstart This shell script demonstrates how to clone a sample project repository using Git and then navigate into the cloned directory. It ensures Git is installed before proceeding. ```shellscript git clone git@github.com:voxelize/voxelize.git && cd voxelize ``` -------------------------------- ### CLI Overview Source: https://docs.cursor.com/fr/troubleshooting/common-issues Getting started with the Cursor CLI, including installation and basic usage. ```APIDOC ## CLI - Getting Started ### Overview This section covers the initial steps for using the Cursor Command Line Interface (CLI), enabling you to leverage Cursor's capabilities from your terminal. ### Installation - **Endpoint**: `/cli/installation` - **Description**: Instructions on how to install the Cursor CLI on your system. ### Using the CLI - **Endpoint**: `/cli/using` - **Description**: Basic commands and workflow for interacting with the Cursor CLI. ### MCP (Multi-Cursor Prompt) - **Endpoint**: `/cli/mcp` - **Description**: Information on using MCP for multi-line and multi-file prompts within the CLI. ### Shell Mode - **Endpoint**: `/cli/shell-mode` - **Description**: How to enable and use shell mode for interactive command execution. ``` -------------------------------- ### CLI - Overview and Installation Source: https://docs.cursor.com/ru/agent/chat/summarization Documentation for the Cursor Command Line Interface (CLI), including initial setup and usage. ```APIDOC ## CLI - Overview and Installation ### Description This section covers the basics of the Cursor CLI, from installation to initial usage. ### Pages - **/cli/overview**: General overview of the CLI. - **/cli/installation**: Instructions for installing the CLI. - **/cli/using**: How to use the CLI for various tasks. - **/cli/mcp**: Using the CLI with multi-codebase projects. - **/cli/shell-mode**: Operating the CLI in shell mode. ``` -------------------------------- ### German Documentation: Quickstart Source: https://docs.cursor.com/zh-Hant/guides/working-with-context Quickstart guide for Cursor in German. ```APIDOC ## German Documentation: Quickstart ### Description A quick start guide to get users up and running with Cursor, in German. ### Endpoint `/llmstxt/cursor-llms-full.txt` (This is a placeholder based on the provided text, actual endpoint may differ) ### Parameters No specific parameters are detailed in the provided text for this section. ``` -------------------------------- ### CLI Installation and Usage Source: https://docs.cursor.com/es/context/@-symbols/@-definitions Guides on how to install and use the Cursor CLI, including different modes and references. ```APIDOC ## CLI Documentation ### Description This section covers the installation, usage, and configuration of the Cursor Command Line Interface (CLI). ### Endpoints - `/cli/installation` - `/cli/using` - `/cli/mcp` - `/cli/shell-mode` - `/cli/headless` - `/cli/github-actions` ### Cookbook Recipes - `/cli/cookbook/code-review` - `/cli/cookbook/update-docs` - `/cli/cookbook/fix-ci` - `/cli/cookbook/secret-audit` - `/cli/cookbook/translate-keys` ### CLI References - `/cli/reference/slash-commands` - `/cli/reference/parameters` - `/cli/reference/authentication` - `/cli/reference/permissions` - `/cli/reference/configuration` - `/cli/reference/output-format` ``` -------------------------------- ### Guides - Tutorials Source: https://docs.cursor.com/de/account/teams/sso Tutorials for various aspects of Cursor development, starting with web development. ```APIDOC ## Tutorial - Web Development ### Description Tutorial on using Cursor for web development. ### Endpoint `/de/guides/tutorials/web-dev` ``` -------------------------------- ### Guides - Core Source: https://docs.cursor.com/pt-BR/agent/overview Core guides for using Cursor, starting with working with context. ```APIDOC ## Guides: Working with Context ### Description A guide on how to effectively work with context in Cursor. ### Endpoint `/de/guides/working-with-context` ``` -------------------------------- ### CLI Overview Source: https://docs.cursor.com/de/guides/working-with-context Documentation for the Cursor Command Line Interface (CLI), covering getting started, headless operations, and reference materials. ```APIDOC ## CLI Overview ### Description Guides and references for using the Cursor CLI for various development tasks. ### Getting Started - Overview: `/cli/overview` - Installation: `/cli/installation` - Usage: `/cli/using` - MCP: `/cli/mcp` - Shell Mode: `/cli/shell-mode` ### Headless Operations - Headless: `/cli/headless` - GitHub Actions: `/cli/github-actions` #### Cookbook - Code Review: `/cli/cookbook/code-review` - Update Docs: `/cli/cookbook/update-docs` - Fix CI: `/cli/cookbook/fix-ci` - Secret Audit: `/cli/cookbook/secret-audit` - Translate Keys: `/cli/cookbook/translate-keys` ### Reference - Slash Commands: `/cli/reference/slash-commands` - Parameters: `/cli/reference/parameters` - Authentication: `/cli/reference/authentication` - Permissions: `/cli/reference/permissions` - Configuration: `/cli/reference/configuration` - Output Format: `/cli/reference/output-format` ``` -------------------------------- ### CLI Installation Source: https://docs.cursor.com/es/guides/working-with-context Instructions for installing the Cursor CLI tool. ```APIDOC ## GET /cli/installation ### Description Provides instructions for installing the Cursor CLI. ### Method GET ### Endpoint /cli/installation ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **installation_instructions** (string) - Step-by-step guide for installing the CLI. ``` -------------------------------- ### CLI Installation Source: https://docs.cursor.com/pt-BR/integrations/github Instructions for installing the Cursor CLI. ```APIDOC ## CLI Installation ### Description Instructions for installing the Cursor CLI. ### Endpoint `/cli/installation` ### Method GET ``` -------------------------------- ### POST /v0/agents Source: https://docs.cursor.com/fr/get-started/quickstart Einen neuen Hintergrundagenten starten, der an deinem Repository arbeitet. ```APIDOC ## POST /v0/agents ### Description Einen neuen Hintergrundagenten starten, der an deinem Repository arbeitet. ### Method POST ### Endpoint /v0/agents ### Parameters #### Request Body - **repository_id** (string) - Required - Die ID des GitHub-Repositorys, an dem der Agent arbeiten soll. - **model** (string) - Optional - Das zu verwendende KI-Modell. - **name** (string) - Optional - Der Name für den neuen Agenten. ### Request Example ```json { "repository_id": "github.com/user/repo", "model": "gpt-4", "name": "My New Agent" } ``` ### Response #### Success Response (201) - **id** (string) - Die ID des neu erstellten Agents. - **name** (string) - Der Name des neu erstellten Agents. - **status** (string) - Der anfängliche Status des Agents (z.B. 'initializing'). #### Response Example ```json { "id": "agent-456", "name": "My New Agent", "status": "initializing" } ``` ``` -------------------------------- ### GET /v0/repositories Source: https://docs.cursor.com/fr/get-started/quickstart Eine Liste von GitHub-Repositories abrufen, auf die der authentifizierte Nutzer Zugriff hat. ```APIDOC ## GET /v0/repositories ### Description Eine Liste von GitHub-Repositories abrufen, auf die der authentifizierte Nutzer Zugriff hat. ### Method GET ### Endpoint /v0/repositories ### Parameters #### Query Parameters - **limit** (integer) - Optional - Die Anzahl der zurückzugebenden Repositories. - **offset** (integer) - Optional - Die Anzahl der zu überspringenden Repositories. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **repositories** (array) - Eine Liste von GitHub-Repositories. - **id** (string) - Die eindeutige Kennung des Repositorys. - **full_name** (string) - Der vollständige Name des Repositorys (z.B. 'user/repo'). - **url** (string) - Die URL des Repositorys. #### Response Example ```json { "repositories": [ { "id": "repo-1", "full_name": "myuser/myrepo", "url": "https://github.com/myuser/myrepo" } ] } ``` ``` -------------------------------- ### German Documentation - Welcome & Get Started Source: https://docs.cursor.com/fr/agent/modes Initial documentation in German, covering welcome information and getting started guides. ```APIDOC ## German Documentation: Welcome & Get Started ### Description This section provides introductory documentation in German. ### Groups - **Get Started** - `de/welcome` - `de/get-started/installation` - `de/get-started/quickstart` - `de/get-started/concepts` ``` -------------------------------- ### Agent starten Source: https://docs.cursor.com/zh-Hant/get-started/quickstart Einen neuen Hintergrundagenten starten, der an deinem Repository arbeitet. ```APIDOC ## POST /v0/agents ### Description Einen neuen Hintergrundagenten starten, der an deinem Repository arbeitet. ### Method POST ### Endpoint /v0/agents ### Parameters #### Request Body - **repositoryId** (string) - Required - Die ID des Repositorys, an dem der Agent arbeiten soll. - **prompt** (string) - Required - Die Anweisung oder Aufgabe für den Agenten. - **model** (string) - Optional - Das zu verwendende Modell (z.B. "gpt-4"). ### Request Example ```json { "repositoryId": "repo-456", "prompt": "Analyze the code for potential security vulnerabilities." } ``` ### Response #### Success Response (201) - **id** (string) - Die ID des neu erstellten Agenten. - **status** (string) - Der anfängliche Status des Agenten (z.B. "queued"). #### Response Example ```json { "id": "agent-789", "status": "queued" } ``` ``` -------------------------------- ### GitHub-Repositories auflisten Source: https://docs.cursor.com/zh-Hant/get-started/quickstart Eine Liste von GitHub-Repositories abrufen, auf die der authentifizierte Nutzer Zugriff hat. ```APIDOC ## GET /v0/repositories ### Description Eine Liste von GitHub-Repositories abrufen, auf die der authentifizierte Nutzer Zugriff hat. ### Method GET ### Endpoint /v0/repositories ### Parameters #### Query Parameters - **page** (integer) - Optional - Die Seitennummer für die Paginierung. - **pageSize** (integer) - Optional - Die Anzahl der Elemente pro Seite. ### Response #### Success Response (200) - **repositories** (array) - Eine Liste von Repository-Objekten. - **id** (string) - Die eindeutige ID des Repositorys. - **name** (string) - Der Name des Repositorys. - **url** (string) - Die URL des Repositorys. #### Response Example ```json { "repositories": [ { "id": "repo-456", "name": "my-awesome-project", "url": "https://github.com/user/my-awesome-project" } ], "pagination": { "nextCursor": "cursor-def" } } ``` ``` -------------------------------- ### German Documentation: Getting Started Source: https://docs.cursor.com/ru/agent/tools German language documentation for getting started with Cursor. ```APIDOC ## German Documentation: Getting Started ### Description Eine Einführung in Cursor auf Deutsch, die die ersten Schritte abdeckt, einschließlich Installation und grundlegender Konzepte. ### Endpoints - `de/welcome` - `de/get-started/installation` - `de/get-started/quickstart` - `de/get-started/concepts` ``` -------------------------------- ### German Documentation: Installation Source: https://docs.cursor.com/zh-Hant/guides/working-with-context Installation guide for Cursor in German. ```APIDOC ## German Documentation: Installation ### Description Instructions on how to install Cursor, provided in German. ### Endpoint `/llmstxt/cursor-llms-full.txt` (This is a placeholder based on the provided text, actual endpoint may differ) ### Parameters No specific parameters are detailed in the provided text for this section. ``` -------------------------------- ### Guides - Tutorials Source: https://docs.cursor.com/id/account/pricing Tutorials for various use cases, such as web development and building servers. ```APIDOC ## Web Development Tutorial ### Description A tutorial focused on web development using Cursor. ### Method GET ### Endpoint /de/guides/tutorials/web-development ## Architectural Diagrams Tutorial ### Description A tutorial on creating architectural diagrams with Cursor. ### Method GET ### Endpoint /de/guides/tutorials/architectural-diagrams ## Building MCP Server Tutorial ### Description A tutorial on building an MCP server using Cursor. ### Method GET ### Endpoint /de/guides/tutorials/building-mcp-server ``` -------------------------------- ### Guides Source: https://docs.cursor.com/ru/cli/installation Comprehensive guides on various aspects of Cursor LLM, including core concepts, tutorials, and advanced usage. ```APIDOC ## Cursor LLM Guides ### Description Guides covering core functionalities, tutorials for specific development tasks, advanced techniques, editor migration, and language/framework specific usage of Cursor LLM. ### Method N/A (Documentation) ### Endpoint N/A (Documentation) ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### GET /v0/agents/{id} Source: https://docs.cursor.com/fr/get-started/quickstart Hol dir den aktuellen Status und die Ergebnisse eines bestimmten Hintergrundagents. ```APIDOC ## GET /v0/agents/{id} ### Description Hol dir den aktuellen Status und die Ergebnisse eines bestimmten Hintergrundagents. ### Method GET ### Endpoint /v0/agents/{id} ### Parameters #### Path Parameters - **id** (string) - Required - Die ID des abzurufenden Agents. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **id** (string) - Die eindeutige Kennung des Agents. - **name** (string) - Der Name des Agents. - **status** (string) - Der aktuelle Status des Agents. - **last_result** (object) - Die letzten Ergebnisse des Agents. #### Response Example ```json { "id": "agent-123", "name": "My Code Agent", "status": "running", "last_result": { "output": "Code analysis complete." } } ``` ``` -------------------------------- ### Guides - Tutorials Source: https://docs.cursor.com/pt-BR/agent/overview Tutorials for various use cases, including web development, architectural diagrams, and building MCP servers. ```APIDOC ## Guides: Tutorials - Web Development ### Description A tutorial focused on web development using Cursor. ### Endpoint `/de/guides/tutorials/web-development` --- ## Guides: Tutorials - Architectural Diagrams ### Description A tutorial on creating architectural diagrams with Cursor. ### Endpoint `/de/guides/tutorials/architectural-diagrams` --- ## Guides: Tutorials - Building MCP Server ### Description A tutorial on building an MCP server using Cursor. ### Endpoint `/de/guides/tutorials/building-mcp-server` ``` -------------------------------- ### Install Cursor LLM CLI (Shell Script) Source: https://docs.cursor.com/de/cli/installation This script installs the Cursor LLM command-line interface (CLI) on macOS, Linux, and Windows (WSL) using curl and bash. It's a one-line command for easy setup. Ensure you have curl and bash installed. ```shellscript curl -fsS https://cursor.com/install | bash ``` -------------------------------- ### Verify Cursor LLM CLI Installation (Shell Script) Source: https://docs.cursor.com/de/cli/installation This command verifies that the Cursor LLM CLI has been installed correctly. Running 'cursor --version' should output the installed version number. This helps confirm the installation was successful. ```shellscript cursor --version ``` -------------------------------- ### POST /v0/agents - Launch Agent Source: https://docs.cursor.com/id/get-started/quickstart Starts a new background agent that works on your repository. ```APIDOC ## POST /v0/agents ### Description Starts a new background agent to work on your repository. ### Method POST ### Endpoint /v0/agents ### Parameters #### Request Body - **repository_id** (string) - Required - The ID of the repository to work on. - **model** (string) - Optional - The model to use for the agent. - **instructions** (string) - Optional - Specific instructions for the agent. ### Request Example ```json { "repository_id": "repo-abc", "model": "gpt-4", "instructions": "Analyze the performance bottlenecks." } ``` ### Response #### Success Response (200) - **agent_id** (string) - The ID of the newly launched agent. #### Response Example ```json { "agent_id": "agent-456" } ``` ``` -------------------------------- ### Cursor CLI - Installation and Usage Source: https://docs.cursor.com/fr/context/@-symbols/@-recent-changes Guides on installing and using the Cursor Command Line Interface (CLI), including shell mode and MCP. ```APIDOC ## Cursor CLI ### Description This section covers the installation and various ways to use the Cursor CLI, including headless operations and cookbook recipes. ### Endpoints - `/cli/using` - `/cli/mcp` - `/cli/shell-mode` - `/cli/headless` - `/cli/github-actions` ### Cookbook Recipes - `/cli/cookbook/code-review` - `/cli/cookbook/update-docs` - `/cli/cookbook/fix-ci` - `/cli/cookbook/secret-audit` - `/cli/cookbook/translate-keys` ### Reference - `/cli/reference/slash-commands` - `/cli/reference/parameters` - `/cli/reference/authentication` - `/cli/reference/permissions` - `/cli/reference/configuration` - `/cli/reference/output-format` ``` -------------------------------- ### Environment JSON Configuration for Background Agents Source: https://docs.cursor.com/ja/background-agent Defines the structure for the `environment.json` file, which specifies snapshot settings, installation commands, and terminal configurations for background agents. The `terminals` array allows for defining specific commands to run in separate tmux sessions, such as starting a development server like Next.js. ```json { "snapshot": "POPULATED_FROM_SETTINGS", "install": "npm install", "terminals": [ { "name": "Next.js を起動", "command": "npm run dev" } ] } ``` -------------------------------- ### CLI Overview Source: https://docs.cursor.com/ru/cli/installation Information on using the Cursor LLM Command Line Interface, including installation and general usage. ```APIDOC ## CLI Overview ### Description Provides an overview of the Cursor LLM CLI, including installation instructions and common usage patterns. ### Method N/A (Documentation) ### Endpoint N/A (Documentation) ### Parameters None ### Request Example None ### Response None ``` -------------------------------- ### Verify Cursor CLI Installation Source: https://docs.cursor.com/de/cli/installation After installing the Cursor CLI, use this command to verify that the agent is functioning correctly. This command checks the agent's version information. ```shell cursor-agent --version ``` -------------------------------- ### GET /v0/models Source: https://docs.cursor.com/fr/get-started/quickstart Eine Liste empfohlener Modelle für Background-Agents abrufen. ```APIDOC ## GET /v0/models ### Description Eine Liste empfohlener Modelle für Background-Agents abrufen. ### Method GET ### Endpoint /v0/models ### Parameters No parameters required. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **models** (array) - Eine Liste von verfügbaren Modellen. - **name** (string) - Der Name des Modells. - **description** (string) - Eine Beschreibung des Modells. #### Response Example ```json { "models": [ { "name": "gpt-4", "description": "Most capable model." }, { "name": "gpt-3.5-turbo", "description": "Fast and capable model." } ] } ``` ``` -------------------------------- ### Guides and Tutorials Source: https://docs.cursor.com/es/context/@-symbols/overview Guides and tutorials for using Cursor effectively, including working with context, editor migration, and advanced topics. ```APIDOC ## Working with Context ### Description A guide on how to work with context in Cursor. ### Method GET ### Endpoint /de/guides/working-with-context ## Tutorial: Web Development ### Description A tutorial on using Cursor for web development. ### Method GET ### Endpoint /de/guides/tutorials/web-development ## Tutorial: Architectural Diagrams ### Description A tutorial on creating architectural diagrams with Cursor. ### Method GET ### Endpoint /de/guides/tutorials/architectural-diagrams ## Tutorial: Building MCP Server ### Description A tutorial on building an MCP server using Cursor. ### Method GET ### Endpoint /de/guides/tutorials/building-mcp-server ## Advanced: Large Codebases ### Description Guidance on handling large codebases with Cursor. ### Method GET ### Endpoint /de/guides/advanced/large-codebases ## Advanced: Working with Documentation ### Description Advanced techniques for working with documentation in Cursor. ### Method GET ### Endpoint /de/guides/advanced/working-with-documentation ## Advanced: Data Science ### Description Guidance on using Cursor for data science tasks. ### Method GET ### Endpoint /de/guides/advanced/datascience ## Editor Migration ### Description Information on migrating from other editors to Cursor. ### Method GET ### Endpoint /de/guides/migrati ``` -------------------------------- ### Background Agents API Overview Source: https://docs.cursor.com/ja/cli/reference/output-format Provides an overview of the Background Agents API, including its capabilities and how to get started. ```APIDOC ## GET /background-agent/api/overview ### Description Provides an overview of the Background Agents API. ### Method GET ### Endpoint /background-agent/api/overview ### Parameters #### Query Parameters - None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **overview** (string) - A summary of the Background Agents API. #### Response Example ```json { "overview": "The Background Agents API allows you to programmatically manage and interact with background agents for various tasks." } ``` ``` -------------------------------- ### Configuration API Source: https://docs.cursor.com/zh-Hant/get-started/quickstart API endpoints for managing application configuration. ```APIDOC ## Configuration API ### Description API endpoints for managing various configuration settings. ### Method GET ### Endpoint /configuration/kbd ### Description Manages keyboard shortcut configurations. ### Method GET ### Endpoint /configuration/themes ### Description Manages theme configurations. ### Method GET ### Endpoint /configuration/shell ### Description Manages shell configurations. ``` -------------------------------- ### Cursor CLI Overview Source: https://docs.cursor.com/de/background-agents This section provides an overview of the Cursor CLI, including initial setup and basic usage instructions. ```APIDOC ## Cursor CLI ### Description The Cursor CLI allows you to interact with Cursor features directly from your terminal. This includes managing background agents, accessing repositories, and more. ### Getting Started To begin using the Cursor CLI, you first need to install it. Refer to the installation guide for detailed instructions. ### Available Commands - **`cursor agent`**: Commands related to managing background agents. - **`cursor repo`**: Commands for interacting with repositories. ### Example Usage ```bash cursor agent list cursor repo add ``` ``` -------------------------------- ### Launch Agent Source: https://docs.cursor.com/zh-Hant/cli/installation Start a new background agent that works on your repository. ```APIDOC ## POST /v0/agents ### Description Start a new background agent that works on your repository. ### Method POST ### Endpoint /v0/agents ### Parameters #### Request Body - **name** (string) - Required - The name of the agent. - **model** (string) - Optional - The model to use for the agent. - **repository_id** (string) - Required - The ID of the repository to work on. ### Request Example ```json { "name": "Code Refactoring Agent", "model": "gpt-4", "repository_id": "repo-456" } ``` ### Response #### Success Response (201) - **id** (string) - The unique identifier of the newly created agent. - **status** (string) - The initial status of the agent. #### Response Example ```json { "id": "agent-789", "status": "initializing" } ``` ``` -------------------------------- ### Example MCP Server Configuration JSON Source: https://docs.cursor.com/de/tools/developers This JSON object represents the configuration for a single MCP server. It specifies the 'postgres' service, including its command, arguments, and connection string. This configuration can be serialized and base64 encoded to create install links. ```json { "postgres": { "command": "npx", "args": [ "-y", "@modelcontextprotocol/server-postgres", "postgresql://localhost/mydb" ] } } ``` -------------------------------- ### CLI API Reference Source: https://docs.cursor.com/zh-Hant/cli/github-actions Documentation for the Cursor Command Line Interface (CLI), covering getting started, headless operations, and command reference. ```APIDOC ## CLI API Reference ### Description Documentation for the Cursor CLI, enabling users to interact with Cursor features from the command line. #### Getting Started - **GET /de/cli/overview**: Overview of the CLI. - **GET /de/cli/installation**: Instructions for installing the CLI. - **GET /de/cli/using**: How to use the CLI. - **GET /de/cli/mcp**: Using the CLI with MCP. - **GET /de/cli/shell-mode**: Using the CLI in shell mode. #### Headless Operations - **GET /de/cli/headless**: Running Cursor in headless mode. - **GET /de/cli/github-actions**: Integrating CLI with GitHub Actions. ##### Cookbook - **GET /de/cli/cookbook/code-review**: CLI cookbook for code review. - **GET /de/cli/cookbook/update-docs**: CLI cookbook for updating documentation. - **GET /de/cli/cookbook/fix-ci**: CLI cookbook for fixing CI issues. - **GET /de/cli/cookbook/secret-audit**: CLI cookbook for secret auditing. - **GET /de/cli/cookbook/translate-keys**: CLI cookbook for translating keys. #### Reference - **GET /de/cli/reference/slash-commands**: Reference for CLI slash commands. - **GET /de/cli/reference/parameters**: Reference for CLI parameters. - **GET /de/cli/reference/authentication**: CLI authentication methods. - **GET /de/cli/reference/permissions**: CLI permission details. - **GET /de/cli/reference/configuration**: CLI configuration options. - **GET /de/cli/reference/output-format**: CLI output formats. ``` -------------------------------- ### Cursor CLI - Cookbook Source: https://docs.cursor.com/id/cli/installation Recipes and examples for using the Cursor CLI for various development tasks. ```APIDOC ## CLI Cookbook - Code Review ### Description Example of using the CLI to perform a code review. ### Method N/A (CLI command) ### Endpoint N/A ### Usage Example ```bash cursor cookbook code-review --path ./src ``` ## CLI Cookbook - Update Docs ### Description Example of using the CLI to update documentation files. ### Method N/A (CLI command) ### Endpoint N/A ### Usage Example ```bash cursor cookbook update-docs --path ./docs ``` ## CLI Cookbook - Fix CI ### Description Example of using the CLI to automatically fix Continuous Integration issues. ### Method N/A (CLI command) ### Endpoint N/A ### Usage Example ```bash cursor cookbook fix-ci --path ./.github/workflows ``` ## CLI Cookbook - Secret Audit ### Description Example of using the CLI to audit code for potential secrets. ### Method N/A (CLI command) ### Endpoint N/A ### Usage Example ```bash cursor cookbook secret-audit --path ./config ``` ## CLI Cookbook - Translate Keys ### Description Example of using the CLI to translate localization keys. ### Method N/A (CLI command) ### Endpoint N/A ### Usage Example ```bash cursor cookbook translate-keys --locale en --target fr --path ./locale ``` ``` -------------------------------- ### Cursor Documentation (German) Source: https://docs.cursor.com/es/tools/mcp German documentation for Cursor, covering getting started, core features, background agents API, and inline editing. ```APIDOC ## Cursor Dokumentation (Deutsch) ### Beschreibung Diese Sektion bietet die Dokumentation für Cursor in deutscher Sprache, einschließlich Anleitungen für den Einstieg, Kernfunktionen, die API für Hintergrundagenten und Inline-Bearbeitung. ### Themen - **Erste Schritte:** - `de/welcome` - `de/get-started/installation` - `de/get-started/quickstart` - `de/get-started/concepts` - **Kernfunktionen:** - `de/tab/overview` - **Agent:** - `de/agent/overview` - **Chat:** - `de/agent/chat/tabs` - `de/agent/chat/checkpoints` - `de/agent/chat/export` - `de/agent/chat/duplicate` - `de/agent/chat/history` - `de/agent/chat/summarization` - `de/agent/chat/compact` - `de/agent/chat/commands` - `de/agent/planning` - `de/agent/modes` - `de/agent/tools` - `de/agent/apply` - `de/agent/review` - `de/agent/terminal` - `de/background-agent` - **Background Agents API:** - `de/background-agent/api/overview` - `de/background-agent/api/webhooks` - **API-Endpunkte:** - **Agent-Informationen:** - `de/background-agent/api/list-agents` - `de/background-agent/api/agent-status` - `de/background-agent/api/agent-conversation` - **Agentenverwaltung:** - `de/background-agent/api/launch-an-agent` - `de/background-agent/api/add-followup` - `de/background-agent/api/delete-agent` - **Allgemeine Endpunkte:** - `de/background-agent/api/api-key-info` - `de/background-agent/api/list-models` - `de/background-agent/api/list-repositories` - `de/background-agent/web-and-mobile` - **Inline-Bearbeitung:** - `de/inline-edit/overview` - `de/inline-edit/terminal` - `de/context/rules` - `de/context/memories` - **Kontext:** - `de/context/codebase-indexing` - `de/context/ignore-files` - `de/context/mcp` - **@-Symbole:** - `de/context/@-symbols/overview` - `de/context/@-symbols/@-files-and-folders` - `de/context/@-symbols/@-code` - `de/context/@-symbols/@-docs` - `de/context/@-symbols/@-git` - `de/context/@-symbols/@-past-chats` - `de/context/@-symbols/@-cursor-rules` - `de/context/@-symbols/@-web` - `de/context/@-symbols/@-link` ``` -------------------------------- ### Guides Documentation Source: https://docs.cursor.com/ko/guides/tutorials/web-development Comprehensive guides for using Cursor IDE, covering core concepts, tutorials, advanced topics, editor migration, and language/framework support. ```APIDOC ## Guides Documentation ### Description This section provides various guides to help users effectively utilize Cursor IDE for different development workflows and tasks. ### Core Guides - **Working with Context**: `id/guides/working-with-context` ### Tutorials - **Web Development**: `id/guides/tutorials/web-development` - **Architectural Diagrams**: `id/guides/tutorials/architectural-diagrams` - **Building MCP Server**: `id/guides/tutorials/building-mcp-server` ### Advanced Guides - **Large Codebases**: `id/guides/advanced/large-codebases` - **Working with Documentation**: `id/guides/advanced/working-with-documentation` - **Data Science**: `id/guides/advanced/datascience` ### Editor Migration - **VS Code Migration**: `id/guides/migration/vscode` - **JetBrains Migration**: `id/guides/migration/jetbrains` ### Languages & Frameworks - **Python**: `id/guides/languages/python` - **JavaScript**: `id/guides/languages/javascript` - **Swift**: `id/guides/languages/swift` - **Java**: `id/guides/languages/java` ``` -------------------------------- ### Cursor Guides Source: https://docs.cursor.com/zh-Hant/get-started/concepts Documentation for various guides on using Cursor, including core concepts, tutorials, advanced topics, editor migrations, and language-specific support. ```APIDOC ## Cursor Guides ### Description This section outlines the available guides for using Cursor effectively, covering a wide range of topics from basic usage to advanced techniques and integrations. ### Guide Categories #### Core Guides - `/id/guides/working-with-context`: Guide on effectively working with context in Cursor. #### Tutorials - `/id/guides/tutorials/web-development`: Tutorial for web development using Cursor. - `/id/guides/tutorials/architectural-diagrams`: Tutorial on creating architectural diagrams with Cursor. - `/id/guides/tutorials/building-mcp-server`: Tutorial for building an MCP server. #### Advanced Guides - `/id/guides/advanced/large-codebases`: Techniques for handling large codebases. - `/id/guides/advanced/working-with-documentation`: Strategies for working with documentation. - `/id/guides/advanced/datascience`: Guide for data science applications. #### Editor Migration Guides - `/id/guides/migration/vscode`: Guide for migrating from VS Code to Cursor. - `/id/guides/migration/jetbrains`: Guide for migrating from JetBrains IDEs to Cursor. #### Language & Framework Guides - `/id/guides/languages/python`: Guide for Python development. - `/id/guides/languages/javascript`: Guide for JavaScript development. - `/id/guides/languages/swift`: Guide for Swift development. - `/id/guides/languages/java`: Guide for Java development. ``` -------------------------------- ### Example Cursor LLM JSON Response Source: https://docs.cursor.com/de/account/teams/admin-api This is an example of a JSON response provided by Cursor LLMs. It demonstrates the structure and typical values for fields like member name, email, role, and billing information. This serves as a practical guide for integrating with the Cursor LLM API. ```json { "spendCents": 1000, "fastPremiumRequests": 5, "name": "John Doe", "email": "john.doe@example.com", "role": "member", "hardLimitOverrideDollars": null, "subscriptionCycleStart": 1678886400000, "totalMembers": 10, "totalPages": 2 } ``` -------------------------------- ### GET /v0/agents Source: https://docs.cursor.com/fr/get-started/quickstart Abfrage einer paginierten Liste aller Hintergrund-Agents für den authentifizierten User. ```APIDOC ## GET /v0/agents ### Description Abfrage einer paginierten Liste aller Hintergrund-Agents für den authentifizierten User. ### Method GET ### Endpoint /v0/agents ### Parameters #### Query Parameters - **limit** (integer) - Optional - Die Anzahl der zurückzugebenden Agents. - **offset** (integer) - Optional - Die Anzahl der zu überspringenden Agents. ### Request Example ```json { "example": "" } ``` ### Response #### Success Response (200) - **agents** (array) - Eine Liste von Hintergrund-Agents. - **id** (string) - Die eindeutige Kennung des Agents. - **name** (string) - Der Name des Agents. - **status** (string) - Der aktuelle Status des Agents (z.B. 'running', 'stopped'). #### Response Example ```json { "agents": [ { "id": "agent-123", "name": "My Code Agent", "status": "running" } ] } ``` ``` -------------------------------- ### Cursor Documentation (German) Source: https://docs.cursor.com/id/tools/mcp German language documentation for Cursor, covering getting started, core features, background agents, inline editing, and context management. ```APIDOC ## Cursor Documentation (German) ### Description Diese Dokumentation ist auf Deutsch verfasst und deckt verschiedene Aspekte von Cursor ab. ### Bereiche - **Erste Schritte**: `de/welcome`, `de/get-started/installation`, `de/get-started/quickstart`, `de/get-started/concepts` - **Kern**: `de/tab/overview`, `de/agent/overview`, `de/background-agent`, `de/inline-edit/overview`, `de/context/rules`, `de/context/memories` - **Agent**: `de/agent/planning`, `de/agent/modes`, `de/agent/tools`, `de/agent/apply`, `de/agent/review`, `de/agent/terminal`, `de/background-agent/web-and-mobile`, `de/inline-edit/terminal` - **Chat**: `de/agent/chat/tabs`, `de/agent/chat/checkpoints`, `de/agent/chat/export`, `de/agent/chat/duplicate`, `de/agent/chat/history`, `de/agent/chat/summarization`, `de/agent/chat/compact`, `de/agent/chat/commands` - **Background Agents API**: `de/background-agent/api/overview`, `de/background-agent/api/webhooks` - **Agent Information**: `de/background-agent/api/list-agents`, `de/background-agent/api/agent-status`, `de/background-agent/api/agent-conversation` - **Agent Management**: `de/background-agent/api/launch-an-agent`, `de/background-agent/api/add-followup`, `de/background-agent/api/delete-agent` - **General Endpoints**: `de/background-agent/api/api-key-info`, `de/background-agent/api/list-models`, `de/background-agent/api/list-repositories` - **Context**: `de/context/codebase-indexing`, `de/context/ignore-files`, `de/context/mcp` - **@-Symbole**: `de/context/@-symbols/overview`, `de/context/@-symbols/@-files-and-folders`, `de/context/@-symbols/@-code`, `de/context/@-symbols/@-docs`, `de/context/@-symbols/@-git`, `de/context/@-symbols/@-past-chats`, `de/context/@-symbols/@-cursor-rules`, `de/context/@-symbols/@-web`, `de/context/@-symbols/@-link` ``` -------------------------------- ### Start Cursor Agent Source: https://docs.cursor.com/de/cli/installation This command initiates the Cursor agent service. Ensure your PATH is correctly configured before running this command. ```shell cursor-agent ``` -------------------------------- ### CLI Overview Source: https://docs.cursor.com/zh-Hant/get-started/quickstart Documentation for the Cursor Command Line Interface (CLI). ```APIDOC ## Cursor CLI Documentation ### Description This section provides documentation for the Cursor Command Line Interface (CLI), covering its features, usage, and reference. ## Getting Started ### Method GET ### Endpoint /cli/overview ### Description Provides an overview of the Cursor CLI. ### Method GET ### Endpoint /cli/installation ### Description Instructions for installing the Cursor CLI. ### Method GET ### Endpoint /cli/using ### Description Guide on how to use the Cursor CLI. ### Method GET ### Endpoint /cli/mcp ### Description Information related to MCP (Multi-Context Processing) in the CLI. ### Method GET ### Endpoint /cli/shell-mode ### Description Information about the shell mode in the Cursor CLI. ## Headless ### Method GET ### Endpoint /cli/headless ### Description Information on using the Cursor CLI in headless mode. ### Method GET ### Endpoint /cli/github-actions ### Description Guide on integrating the Cursor CLI with GitHub Actions. ## Cookbook ### Method GET ### Endpoint /cli/cookbook/code-review ### Description CLI cookbook recipe for code review. ### Method GET ### Endpoint /cli/cookbook/update-docs ### Description CLI cookbook recipe for updating documentation. ### Method GET ### Endpoint /cli/cookbook/fix-ci ### Description CLI cookbook recipe for fixing CI issues. ### Method GET ### Endpoint /cli/cookbook/secret-audit ### Description CLI cookbook recipe for secret auditing. ### Method GET ### Endpoint /cli/cookbook/translate-keys ### Description CLI cookbook recipe for translating keys. ## Reference ### Method GET ### Endpoint /cli/reference/slash-commands ### Description Reference for slash commands available in the CLI. ### Method GET ### Endpoint /cli/reference/parameters ### Description Reference for parameters accepted by CLI commands. ### Method GET ### Endpoint /cli/reference/authentication ### Description Information on authentication methods for the CLI. ### Method GET ### Endpoint /cli/reference/permissions ### Description Information on permissions related to the CLI. ### Method GET ### Endpoint /cli/reference/configuration ### Description Reference for CLI configuration options. ### Method GET ### Endpoint /cli/reference/output-format ### Description Information on the output formats supported by the CLI. ``` -------------------------------- ### Install Anysphere Remote SSH Extension (Shell) Source: https://docs.cursor.com/de/troubleshooting/common-issues This guide details how to replace the standard Remote-SSH extension with the Anysphere Remote SSH extension in Cursor to resolve connection issues on Windows. It involves uninstalling the existing extension and installing the new one from the Cursor marketplace. ```shell Open Extensions view (Ctrl + Shift + X) Search for 'Remote-SSH' Click the gear icon → 'Uninstall' Open Cursor marketplace Search for 'SSH' Install the Anysphere Remote SSH extension Close all VS Code instances with active SSH connections Restart Cursor Connect via SSH again ``` -------------------------------- ### POST /v0/agents/{id}/followup Source: https://docs.cursor.com/fr/get-started/quickstart Sende eine zusätzliche Anweisung an einen laufenden Hintergrundagenten. ```APIDOC ## POST /v0/agents/{id}/followup ### Description Sende eine zusätzliche Anweisung an einen laufenden Hintergrundagenten. ### Method POST ### Endpoint /v0/agents/{id}/followup ### Parameters #### Path Parameters - **id** (string) - Required - Die ID des Agents, an den die Anweisung gesendet werden soll. #### Request Body - **instruction** (string) - Required - Die zusätzliche Anweisung für den Agenten. ### Request Example ```json { "instruction": "Refactor this code to improve readability." } ``` ### Response #### Success Response (200) - **message** (string) - Eine Bestätigungsmeldung, dass die Anweisung gesendet wurde. #### Response Example ```json { "message": "Follow-up instruction sent successfully." } ``` ```