Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.coconut.dev/llms.txt

Use this file to discover all available pages before exploring further.

​
Coconut CLI (nut)

The Coconut CLI (nut) is a powerful command-line tool for managing your Coconut instances, agents, and change proposals directly from your terminal.

​
Installation

The nut CLI is included with your Coconut installation.

​
Quick Start

Initialize Coconut in your repository: 
nut init
Check the version: 
nut --version
Get help for any command: 
nut --help
nut <command> --help

​
Command Categories

The nut CLI provides comprehensive commands for managing your Coconut instance:

nut init

Initialize Coconut in your repository

nut task

Manage tasks (change proposals)

nut serve

Launch the Coconut web interface

nut code

AI-assisted task implementation

nut skill

Manage AI skills (agents)

nut resource

Generate images, audio, and video

nut context

Manage context documents

nut knowledge

Manage knowledge base

nut events

View activity events

nut coconut

Call peer Coconut MCP tools

nut connect

Access third-party connectors

nut notify

Send notifications to external services

nut config

Manage configuration and API keys

nut auth

Manage authentication

nut schema

Manage schema reference files

​
Common Workflows

​
Getting Started

# Initialize Coconut in your repository
nut init

# Launch the web interface
nut serve

​
Working with Tasks

# Create a new task
nut task create "Add user authentication feature"

# List all tasks
nut task list

# View details of a specific task
nut task get cp-1234567890

# Add plan steps
nut task step cp-1234567890 "Implement login endpoint"

# Add comments
nut task comment cp-1234567890 "Ready for review"

​
AI-Assisted Development

# Start implementing a task with AI assistance
nut code cp-1234567890

# Use autonomous mode
nut code cp-1234567890 --autonomous

# Work in an isolated git worktree
nut code cp-1234567890 --new-worktree

​
Managing Skills

# List all skills
nut skill list

# Create a new skill
nut skill create "Code Reviewer" "Reviews pull requests for quality"

# Browse the skill registry
nut skill registry

​
Generating Resources

# Generate an image
nut resource image "A modern dashboard interface"

# Generate audio
nut resource audio "Welcome to our platform"

# Generate video
nut resource video "Product demonstration"

​
Managing Knowledge

# Create knowledge document
nut knowledge create "API Guidelines" --file ./docs/api.md

# List all documents
nut knowledge list

# Search knowledge base
nut knowledge list --search "authentication"

​
Working with Peer Coconuts

# List Coconut instances visible to you
nut coconut list

# List tasks on a peer Coconut
nut coconut task list --name coconut-research

# Search knowledge on a peer Coconut
nut coconut knowledge search "runbook" --name coconut-research

# List skills on a peer Coconut
nut coconut skill list --name coconut-research

# Inspect scheduled jobs on a peer Coconut
nut coconut job list --name coconut-research

# Discover raw MCP tools exposed by the Coconut Dashboard
nut coconut tools

​
Notifications

# Post to the configured Slack channel
nut notify slack "Deployment to staging complete"

# Include a title
nut notify slack "All systems operational" --title "Health Check"

​
Context Management

# Update role context
nut context update role --file ./ROLE.md

# Read context
nut context get agents

# Append to context
nut context append team "## Additional guidelines..."