Trellis

https://docs.trytrellis.app
Admin
Trellis is training wheels for AI coding assistants. It automatically injects your project specs...
Tokens:136,110
Snippets:1,424
Trust Score:3.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Local Development Setup and Verification

Source: https://docs.trytrellis.app/contribute/docs

Commands to set up the local development environment, start the dev server, check markdown linting, verify the docs structure, and format files.

```bash
# Install dependencies
pnpm install

# Start local dev server
pnpm dev

# Check markdown lint
pnpm lint:md

# Verify docs structure
pnpm verify

# Format files
pnpm format
```

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

### Starting prompt for a new project

Source: https://docs.trytrellis.app/start/install-and-first-task

Example prompt to initiate a new B2B dashboard project and request AI assistance with setup and specifications.

```text
I am starting a new B2B dashboard from scratch. Help me set up Trellis for the first week of work.

First, ask for the missing product and tech-stack decisions. Then create a small first task and the minimum specs needed for frontend structure, API shape, error handling, and test strategy.
```

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

### Install All Available Skills

Source: https://docs.trytrellis.app/skills-market/frontend-fullchain-optimization

Installs all available skills from the marketplace using npx. This is a broader installation command.

```bash
npx skills add mindfold-ai/marketplace
```

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

### Install Frontend Fullchain Optimization Skill

Source: https://docs.trytrellis.app/skills-market/frontend-fullchain-optimization

Installs the specific frontend-fullchain-optimization skill using npx. Ensure you have Node.js and npm installed.

```bash
npx skills add mindfold-ai/marketplace --skill frontend-fullchain-optimization
```

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

### Install Trellis CLI

Source: https://docs.trytrellis.app/start/install-and-first-task

Install the Trellis CLI globally via npm and navigate to your project directory to begin setup.

```bash
# Global install (beta channel)
npm install -g @mindfoldhq/trellis@latest

# Navigate to your project directory
cd your-project
```

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

### Clone and Install Dependencies

Source: https://docs.trytrellis.app/contribute/docs

Fork the repository on GitHub, clone it locally, and install project dependencies using pnpm.

```bash
# Fork on GitHub first, then:
git clone https://github.com/YOUR_USERNAME/docs.git
cd docs
pnpm install
```

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

### Install Trellis globally

Source: https://docs.trytrellis.app/changelog/v0.5.0-beta.13

Use this command for a fresh installation of the specified Trellis version.

```bash
npm i -g @mindfoldhq/trellis@0.5.0-beta.13
```

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

### Install fresh Trellis version

Source: https://docs.trytrellis.app/changelog/v0.5.0-beta.12

Command to perform a fresh installation of the specific beta version.

```bash
npm i -g @mindfoldhq/trellis@0.5.0-beta.12
```

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

### Kubernetes Control Loop Example

Source: https://docs.trytrellis.app/blog/use-k8s-to-know-trellis

This example demonstrates the power of the Kubernetes control loop in action. It shows how the system automatically detects and recovers from a pod deletion, and adapts to changes in the desired state without manual intervention.

```text
I declare: I want 3 nginx Pods

A Pod gets accidentally deleted → Controller detects 2 ≠ 3 → Auto-creates 1
I modify declaration to 5      → Controller detects 3 ≠ 5 → Auto-creates 2

No manual intervention needed. System auto-detects, auto-recovers, auto-adapts.
```

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

### Example Curated implement.jsonl

Source: https://docs.trytrellis.app/start/everyday-use

An example of a curated implement.jsonl file after AI review for a monorepo with `dev_type=backend`. It contains spec and research files relevant to the task.

```jsonl
{"file": ".trellis/spec/guides/index.md", "reason": "Shared cross-package thinking guides"}
{"file": ".trellis/spec/cli/backend/index.md", "reason": "Backend dev guide — task touches Python scripts"}
{"file": ".trellis/spec/cli/backend/script-conventions.md", "reason": "Script conventions for the affected files"}
{"file": ".trellis/tasks/.../research/auth-library-comparison.md", "reason": "Library choice rationale"}
```

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

### Initialize First-time Project

Source: https://docs.trytrellis.app/start/install-and-first-task

Use this command to create the .trellis/ directory and bootstrap the project specification.

```bash
trellis init -u your-name --claude
```

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

### Initialize with Official Marketplace Templates

Source: https://docs.trytrellis.app/start/install-and-first-task

Use the 'trellis init' command to start a project. You can either use the interactive picker or specify a template ID directly.

```bash
# Interactive: browse and pick from available templates
trellis init -u your-name

# Non-interactive: specify a template by ID
trellis init -u your-name --template electron-fullstack
```

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

### Install Trellis beta

Source: https://docs.trytrellis.app/changelog/v0.6.0-beta.0

Commands to install the beta version of Trellis and update the local installation.

```bash
npm install -g @mindfoldhq/trellis@beta
trellis update
```

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

### Initialize with Marketplace Mode

Source: https://docs.trytrellis.app/advanced/custom-spec-template-marketplace

Use this command to initialize a project using a spec template from a marketplace registry. The source path should point to the directory containing `index.json`.

```bash
trellis init --registry gh:myorg/my-spec-marketplace/marketplace
```

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

### Initialize New Developer or New Machine

Source: https://docs.trytrellis.app/start/install-and-first-task

Use this command when a new developer joins or when working on a new machine to generate an onboarding task.

```bash
trellis init -u their-name
```

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

### Install Trellis CLI

Source: https://docs.trytrellis.app/skills-market/mem-recall

Install the Trellis CLI globally via npm and verify the installation version.

```bash
npm install -g @mindfoldhq/trellis@beta
trellis --version   # ≥ 0.6.0-beta.0
```

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

### Install and Initialize Trellis on Windows

Source: https://docs.trytrellis.app/advanced/appendix-f

Prerequisites include Node.js 18+ and Python 3.9+. Running these commands initializes the project and sets the necessary environment variable for stable path resolution.

```bash
# 1. Install Node.js 18+ and Python 3.9+
# 2. Install Trellis
npm install -g @mindfoldhq/trellis@latest
# 3. Initialize
cd your-project
trellis init -u your-name
```

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

### Install or upgrade Trellis

Source: https://docs.trytrellis.app/changelog/v0.4.0

Commands for performing a fresh installation via npm or upgrading an existing Trellis installation.

```bash
# Fresh install
npm install -g @mindfoldhq/trellis@latest --registry=https://registry.npmjs.org

# Upgrade (existing trellis install)
trellis update
```

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

### Initialize Platform Configurations

Source: https://docs.trytrellis.app/start/install-and-first-task

Use the init command to configure your developer identity and set up specific AI coding platforms. Each platform must be initialized at least once.

```bash
# Interactive: detects installed platforms and asks which to configure
trellis init -u your-name

# Explicit: configure one or more platforms
trellis init -u your-name --claude
trellis init -u your-name --claude --cursor --opencode
trellis init -u your-name --codex --gemini
trellis init -u your-name --pi
```

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

### Check Available Skills

Source: https://docs.trytrellis.app/skills-market/frontend-fullchain-optimization

A command to list all installed skills, used to verify the installation of frontend-fullchain-optimization.

```bash
What skills do you have access to?
```

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

### Initialize with Direct Mode

Source: https://docs.trytrellis.app/advanced/custom-spec-template-marketplace

Use this command for direct mode initialization, where the source path points directly to the desired template directory within a repository. This bypasses the `index.json` lookup.

```bash
trellis init --registry gh:myorg/my-spec-marketplace/marketplace/specs/web-app
```

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

### Cross-Session Memory Example

Source: https://docs.trytrellis.app/start/install-and-first-task

An example of how the AI recalls previous session progress upon startup.

```text
AI: "Hi Alice — last session you finished the user login feature (commit abc1234),
     covering the LoginForm component, JWT middleware, and users table.
     What next?"
```

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

### Initial Trellis Setup Prompt

Source: https://docs.trytrellis.app/start/real-world-scenarios

Use this prompt to initiate a new B2B dashboard project, requesting that the AI gather necessary product and tech-stack decisions before generating initial documentation and specifications.

```text
I am starting a new B2B dashboard from scratch. Help me set up Trellis for the first week of work.

First, ask for the missing product and tech-stack decisions. Then create a small first-task PRD and
the minimum specs needed for frontend structure, API shape, error handling, and tests.
```

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

### Install mem-recall skill

Source: https://docs.trytrellis.app/skills-market

Install the memory recall skill to enable cross-platform conversation history retrieval.

```bash
npx skills add mindfold-ai/marketplace -s mem-recall
```

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

### Install Trellis via NPM

Source: https://docs.trytrellis.app/changelog/v0.5.0-beta.10

Use this command to install the Trellis package globally via NPM.

```bash
npm install -g @mindfoldhq/trellis@beta
```

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

### Initialize with Custom Registry

Source: https://docs.trytrellis.app/start/install-and-first-task

Pull specifications from custom GitHub, GitLab, or Bitbucket repositories using the '--registry' flag. The format follows 'provider:user/repo[/subdir][#ref]'.

```bash
# Direct download: repo directory becomes .trellis/spec/
trellis init --registry gh:myorg/myrepo/my-team-spec

# Marketplace mode: repo has index.json with multiple templates
trellis init --registry gh:myorg/myrepo/marketplace

# Pick a specific template from a custom marketplace
trellis init --registry gh:myorg/myrepo/marketplace --template my-template

# Specify a branch
trellis init --registry gh:myorg/myrepo/specs#develop

# GitLab or Bitbucket
trellis init --registry gitlab:myorg/myrepo/specs
trellis init --registry bitbucket:myorg/myrepo/specs
```

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

### Initialize Qoder CLI

Source: https://docs.trytrellis.app/advanced/multi-platform

Use this command to initialize the Trellis project for the Qoder platform.

```bash
trellis init -u your-name --qoder
```

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

### Initialize Oh My Pi platform

Source: https://docs.trytrellis.app/changelog/v0.6.6

Initializes a new Oh My Pi project, creating the necessary directory structure for agents, commands, skills, and extensions.

```bash
trellis init --omp
```

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

### Install Trellis RC version

Source: https://docs.trytrellis.app/changelog/v0.4.0-rc.1

Use this command to install the release candidate version of Trellis via npm.

```bash
npm install -g @mindfoldhq/trellis@rc
```

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

### Conventional Commit Message Examples

Source: https://docs.trytrellis.app/contribute/docs

Examples of commit messages following the conventional commits specification for documenting changes.

```bash
docs: add Next.js spec template
fix: correct broken link in quickstart
feat: add new skill to marketplace
```

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

### task.py start error message

Source: https://docs.trytrellis.app/changelog/v0.5.0-beta.15

The error message displayed when task.py start is executed without an available session identity.

```text
Error: Cannot set active task without a session identity.
Hint: run inside an AI IDE/session that exposes session identity, or set TRELLIS_CONTEXT_ID before running task.py start.
```

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

### Task JSON Schema Example

Source: https://docs.trytrellis.app/start/everyday-use

This is an example of the task.json structure as written by `task.py create`. Fields are populated over time by various commands.

```json
{
  "id": "02-27-user-login",
  "name": "user-login",
  "title": "Add user login",
  "description": "Implement JWT login flow",
  "status": "planning",
  "dev_type": null,
  "scope": null,
  "package": null,
  "priority": "P1",
  "creator": "alice",
  "assignee": "alice",
  "createdAt": "2026-02-27",
  "completedAt": null,
  "branch": null,
  "base_branch": "main",
  "worktree_path": null,
  "commit": null,
  "pr_url": null,
  "subtasks": [],
  "children": [],
  "parent": null,
  "relatedFiles": [],
  "notes": "",
  "meta": {}
}
```

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

### JSONL File Example for Context Injection

Source: https://docs.trytrellis.app/blog/use-k8s-to-know-trellis

Example of a JSONL file used to specify files and reasons for context injection into an agent.

```jsonl
{"file": ".trellis/spec/backend/index.md", "reason": "Backend guidelines"}
{"file": "src/api/auth.ts", "reason": "Existing auth pattern"}
```

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

### Initialize Trellis with Versioned Spec Template

Source: https://docs.trytrellis.app/advanced/custom-spec-template-marketplace

Installs a specific version of a spec template from the marketplace registry using a Git ref.

```bash
trellis init --registry gh:myorg/my-spec-marketplace/marketplace#v1 --template web-app
```
Tokens:
Raw