Termdock

https://termdock.com/docs
Admin
Termdock unifies multiple AI CLI tools, project workspaces, and file/Git workflows to reduce context...
Tokens:8,951
Snippets:149
Trust Score:6.1
Update:3 months ago
Show doc for...
Tokens:
Raw
### Install AST Skill for Claude Code

Source: https://termdock.com/docs/ast-api

Instructions for installing the 'termdock-ast' skill for Claude Code within Termdock, enabling automatic AST API usage.

```text
1. Open **Settings → Skills** tab in Termdock
2. Select **Claude Code** as target
3. Click **Install** on "termdock-ast" skill
4. Claude Code will now use AST API automatically when relevant
```

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

### Example: Save a Lesson Learned

Source: https://termdock.com/docs/memory

After solving a tricky issue, save it as a lesson using the remember.sh script with the 'lesson' category.

```bash
./remember.sh lesson "description"
```

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

### Example: Save an Architectural Decision

Source: https://termdock.com/docs/memory

When an important architectural decision is made, save it using the remember.sh script with the 'architecture' category.

```bash
./remember.sh architecture "description"
```

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

### Example: Recall Authentication Memories

Source: https://termdock.com/docs/memory

When a user mentions a feature like 'authentication', proactively search for related memories using the recall.sh script.

```bash
./recall.sh authentication
```

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

### File Dependencies Endpoint

Source: https://termdock.com/docs/ast-api

This GET endpoint retrieves the import and export dependencies for a given file within a workspace. Use relative paths for the file parameter.

```http
GET /api/graph/deps?file=src/path/to/file.ts&workspace=<wsId>
```

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

### Example: Recall Familiar Errors

Source: https://termdock.com/docs/memory

If an error appears familiar, use the recall.sh script to search for memories related to the error type.

```bash
./recall.sh "error type"
```

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

### What Does This Call? (Callees) Endpoint

Source: https://termdock.com/docs/ast-api

This GET endpoint finds all symbols that a given function or method calls within a workspace.

```http
GET /api/graph/calls?from=<symbolId>&workspace=<wsId>
```

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

### Get Workspace ID

Source: https://termdock.com/docs/ast-api

Retrieves the workspace ID, which is required for all subsequent API calls.

```bash
curl -s 'http://localhost:3033/api/workspaces' | jq '.data.workspaces[0].id'
```

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

### Who Calls This? (Callers) Endpoint

Source: https://termdock.com/docs/ast-api

This GET endpoint finds all locations that call or reference a specific symbol ID within a workspace.

```http
GET /api/graph/callers?to=<symbolId>&workspace=<wsId>
```

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

### Search Symbols Endpoint

Source: https://termdock.com/docs/ast-api

This GET endpoint is used to search for symbols by name within a specified workspace. It returns a list of matching symbols, including their ID, file path, line number, and type.

```http
GET /api/search?q=<name>&workspace=<wsId>&limit=10
```

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

### Impact Analysis Endpoint

Source: https://termdock.com/docs/ast-api

This GET endpoint performs impact analysis for a given symbol ID up to a specified depth within a workspace. It's essential for refactoring to understand affected symbols and files.

```http
GET /api/impact?symbolId=<id>&depth=2&workspace=<wsId>
```

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

### Pattern A: Find and Understand a Class

Source: https://termdock.com/docs/ast-api

This pattern demonstrates how to find a class using the search API, then analyze its dependencies, and finally read the file with context.

```bash
# 1. Find it
curl 'http://localhost:3033/api/search?q=TerminalService&workspace=ws_xxx&limit=1'
# Note the symbolId and file path

# 2. See what it imports/exports
curl 'http://localhost:3033/api/graph/deps?file=src/main/services/TerminalService.ts&workspace=ws_xxx'

# 3. Now read the file with context
```

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

### File Dependencies

Source: https://termdock.com/docs/ast-api

Retrieves the import and export dependencies for a given file within a workspace.

```APIDOC
## GET /api/graph/deps?file=<filePath>&workspace=<wsId>

### Description
Returns the import and export dependencies for a specified file within a workspace. Helps understand what a file uses and what it provides.

### Method
GET

### Endpoint
/api/graph/deps

### Parameters
#### Query Parameters
- **file** (string) - Required - The relative path to the file (e.g., `src/path/to/file.ts`).
- **workspace** (string) - Required - The ID of the workspace.

### Response
#### Success Response (200)
- **imports** (array) - A list of files imported by this file.
- **exports** (array) - A list of symbols exported by this file.

### Response Example
{
  "data": {
    "imports": ["./otherFile"],
    "exports": ["myFunction"]
  }
}
```

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

### Save Architectural Decisions with Memory Skill

Source: https://termdock.com/docs/features

Utilize the remember.sh script to save architectural decisions, lessons learned, or design patterns for future reference. This helps maintain persistent cross-session memory.

```bash
./remember.sh lesson "node-pty needs explicit shell path"
```

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

### AST API Error Handling

Source: https://termdock.com/docs/ast-api

This table outlines common errors encountered when using the AST API, their potential causes, and recommended actions.

```text
Error| Cause| Action  
---|---|---  
No workspace found| API not running| Start Termdock app  
Empty search results| Symbol not indexed| Try partial name or rebuild index  
404 on symbolId| Stale ID after code change| Re-search to get new ID  
```

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

### Pattern B: Trace Usage

Source: https://termdock.com/docs/ast-api

This pattern shows how to find a function, select the correct symbol ID, and then trace all its callers using the API.

```bash
# 1. Find function
curl 'http://localhost:3033/api/search?q=createSession&workspace=ws_xxx&limit=5'
# Pick the right symbolId

# 2. Find all callers
curl 'http://localhost:3033/api/graph/callers?to=<symbolId>&workspace=ws_xxx'
```

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

### What Does This Call? (Callees)

Source: https://termdock.com/docs/ast-api

Finds all symbols that a given function or method calls within a workspace.

```APIDOC
## GET /api/graph/calls?from=<symbolId>&workspace=<wsId>

### Description
Finds all symbols that a specified function or method calls. Useful for tracing the execution flow and understanding a symbol's direct dependencies.

### Method
GET

### Endpoint
/api/graph/calls

### Parameters
#### Query Parameters
- **from** (string) - Required - The `symbolId` of the function or method to find callees for.
- **workspace** (string) - Required - The ID of the workspace.

### Response
#### Success Response (200)
- **callees** (array) - A list of symbols or functions called by the specified symbol.

### Response Example
{
  "data": {
    "callees": [
      {
        "symbolId": "calleeSymbolId",
        "file": "/path/to/calleeFile.ts",
        "line": 15
      }
    ]
  }
}
```

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

### Search Memories

Source: https://termdock.com/docs/memory

Use the recall.sh script to search for saved memories using keywords. This helps retrieve past decisions, lessons, or patterns.

```bash
./recall.sh <keywords>
```

```bash
./recall.sh terminal session
```

```bash
./recall.sh "error handling"
```

```bash
./recall.sh authentication JWT
```

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

### Search for Symbols using AST API

Source: https://termdock.com/docs/features

Use this command to search for specific symbols like classes or functions within your codebase via the AST API.

```bash
curl 'http://localhost:3033/api/search?q=UserService'
```

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

### AST API Decision Flow

Source: https://termdock.com/docs/ast-api

This flowchart visualizes the decision process for using the AST API based on user queries and the type of information needed.

```text
User asks about code
        |
        v
Is it a "where is X?" question?
    |yes              |no
    v                 v
/api/search      Is it about dependencies?
    |                 |yes         |no
    v                 v            v
Got symbolId?    /api/graph/deps  Is it about call chain?
    |yes                              |yes         |no
    v                                 v            v
Need callers? -----> /api/graph/callers   Use other tools
Need callees? -----> /api/graph/calls
Need impact?  -----> /api/impact
```

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

### Save New Memory

Source: https://termdock.com/docs/memory

Use the remember.sh script to save new memories with a category and content. This is useful for documenting lessons learned, architectural decisions, or coding patterns.

```bash
./remember.sh <category> "<content>"
```

```bash
./remember.sh lesson "node-pty requires explicit shell path on macOS"
```

```bash
./remember.sh architecture "Use EventBus for cross-service communication"
```

```bash
./remember.sh pattern "Always validate user input at API boundaries"
```

```bash
./remember.sh style "Use camelCase for variables, PascalCase for classes"
```

```bash
./remember.sh preference "Prefer functional components over class components"
```

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

### Search Symbols

Source: https://termdock.com/docs/ast-api

Searches for symbols (classes, methods, functions, etc.) within a specified workspace. Returns a list of matching symbols with their IDs, file paths, line numbers, and types.

```APIDOC
## GET /api/search?q=<name>&workspace=<wsId>&limit=10

### Description
Searches for symbols within a specified workspace based on a query name. Useful for finding specific code elements like classes or functions.

### Method
GET

### Endpoint
/api/search

### Parameters
#### Query Parameters
- **q** (string) - Required - The name of the symbol to search for.
- **workspace** (string) - Required - The ID of the workspace to search within.
- **limit** (integer) - Optional - The maximum number of results to return.

### Response
#### Success Response (200)
- **symbolId** (string) - Unique identifier for the symbol, used for other API calls.
- **file** (string) - Absolute path to the file where the symbol is located.
- **line** (integer) - 0-indexed line number where the symbol appears.
- **type** (integer) - The type of the symbol (e.g., 5=Class, 6=Method, 11=Interface, 12=Function).

### Response Example
{
  "data": {
    "workspaces": [
      {
        "symbolId": "someSymbolId",
        "file": "/path/to/file.ts",
        "line": 10,
        "type": 6
      }
    ]
  }
}
```

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

### Search for a Symbol

Source: https://termdock.com/docs/ast-api

Searches for a specific symbol within a given workspace. The result includes a symbolId for further analysis.

```bash
curl 'http://localhost:3033/api/search?q=UserService&workspace=<wsId>&limit=10'
```

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

### Pattern C: Safe Refactoring

Source: https://termdock.com/docs/ast-api

This pattern illustrates how to check the impact of changing a function before making modifications, by reviewing impacted files.

```bash
# Before changing a function, check impact
curl 'http://localhost:3033/api/impact?symbolId=<id>&depth=2&workspace=ws_xxx'
# Review impactedFiles before making changes
```

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

### Rebuild Index Endpoint

Source: https://termdock.com/docs/ast-api

This POST endpoint rebuilds the search index for a given workspace. Use this when search results appear stale after code changes.

```http
POST /api/index/update
Content-Type: application/json
{"workspace":"<wsId>"}
```

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

### Rebuild Index

Source: https://termdock.com/docs/ast-api

Rebuilds the search index for a workspace. Use this after code changes if search results appear stale.

```APIDOC
## POST /api/index/update

### Description
Rebuilds the search index for a specified workspace. This operation should be used after significant code changes to ensure search results are up-to-date.

### Method
POST

### Endpoint
/api/index/update

### Headers
- **Content-Type**: application/json

### Request Body
- **workspace** (string) - Required - The ID of the workspace for which to rebuild the index.

### Request Example
{
  "workspace": "<wsId>"
}

### Response
#### Success Response (200)
- **message** (string) - Confirmation message indicating the index update has started or completed.

### Response Example
{
  "message": "Index update initiated for workspace <wsId>"
}
```

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

### Who Calls This? (Callers)

Source: https://termdock.com/docs/ast-api

Finds all locations (callers) that reference or call a specific symbol within a workspace.

```APIDOC
## GET /api/graph/callers?to=<symbolId>&workspace=<wsId>

### Description
Finds all symbols and locations that call or reference a given symbol. Essential for understanding the usage of a specific piece of code.

### Method
GET

### Endpoint
/api/graph/callers

### Parameters
#### Query Parameters
- **to** (string) - Required - The `symbolId` of the symbol to find callers for.
- **workspace** (string) - Required - The ID of the workspace.

### Response
#### Success Response (200)
- **callers** (array) - A list of locations or symbols that call the specified symbol.

### Response Example
{
  "data": {
    "callers": [
      {
        "symbolId": "callerSymbolId",
        "file": "/path/to/callerFile.ts",
        "line": 25
      }
    ]
  }
}
```

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

### Memory Storage Location

Source: https://termdock.com/docs/memory

Memories are stored in a JSON file located at ~/.termdock/memories.json. This file can also be managed via the Termdock UI.

```bash
~/.termdock/memories.json
```

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

### Remove Memory

Source: https://termdock.com/docs/memory

Use the forget.sh script to remove outdated or incorrect memories by providing keywords. This helps maintain the accuracy and relevance of the memory library.

```bash
./forget.sh "<keywords>"
```

```bash
./forget.sh "old authentication method"
```

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

### Impact Analysis

Source: https://termdock.com/docs/ast-api

Performs impact analysis on a symbol, returning all affected symbols and files. Essential for safe refactoring.

```APIDOC
## GET /api/impact?symbolId=<id>&depth=<depth>&workspace=<wsId>

### Description
Analyzes the impact of changing a specific symbol. Returns all affected symbols and files up to a specified depth, crucial for refactoring and understanding change consequences.

### Method
GET

### Endpoint
/api/impact

### Parameters
#### Query Parameters
- **symbolId** (string) - Required - The ID of the symbol to analyze.
- **depth** (integer) - Optional - The depth of the impact analysis (default is 2).
- **workspace** (string) - Required - The ID of the workspace.

### Response
#### Success Response (200)
- **affectedSymbols** (array) - A list of symbols affected by changes to the input symbol.
- **affectedFiles** (array) - A list of files affected by changes to the input symbol.

### Response Example
{
  "data": {
    "affectedSymbols": ["symbol1", "symbol2"],
    "affectedFiles": ["/path/to/file1.ts", "/path/to/file2.ts"]
  }
}
```

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

### Remove Quarantine Attributes on macOS Big Sur

Source: https://termdock.com/docs/installation

Use this command if you encounter terminal launch issues on macOS Big Sur to remove quarantine attributes from the Termdock application.

```bash
xattr -cr /Applications/Termdock.app
```
Tokens:
Raw