Waymaker docs
Manage documents in Commander. Create, read, update, and list documents within workspaces.
Overview
Manage documents in Commander. Create, read, update, and list documents within workspaces.
Usage
waymaker docs <subcommand> [options]
Subcommands
| Subcommand | Description |
|---|---|
list | List documents in a workspace |
get | Get document content |
create | Create a new document |
update | Update document content |
List Documents
waymaker docs list --workspace <workspace-id>
Output:
Documents (12)
id title type updated
---------------------------------------------------------
doc_abc123 Q1 Planning Document document 2 hours ago
doc_def456 Product Requirements document 1 day ago
doc_ghi789 Meeting Notes document 3 days ago
Filter by Project
waymaker docs list --workspace ws_xxx --project proj_xxx
JSON Output
waymaker docs list --workspace ws_xxx --json
[
{
"id": "doc_abc123",
"title": "Q1 Planning Document",
"type": "document",
"workspace_id": "ws_xxx",
"project_id": "proj_xxx",
"updated_at": "2026-01-21T08:00:00Z"
}
]
Get Document
View Metadata
waymaker docs get <document-id>
Output:
Q1 Planning Document
ID: doc_abc123
Workspace: ws_xxx
Project: proj_xxx
Type: document
Created: January 15, 2026
Updated: 2 hours ago
Content preview:
# Q1 Planning
## Objectives
- Launch new product line
- Expand to 3 new markets
...
Get Raw Content
waymaker docs get <document-id> --content
Returns the full document text content.
Get JSON Content
waymaker docs get <document-id> --raw
Returns the rich text content structure (JSON format).
JSON Output
waymaker docs get <document-id> --json
{
"id": "doc_abc123",
"title": "Q1 Planning Document",
"content": { "type": "doc", "content": [...] },
"text_content": "# Q1 Planning\n\n## Objectives...",
"workspace_id": "ws_xxx",
"project_id": "proj_xxx"
}
Create Document
waymaker docs create \
--workspace <workspace-id> \
--title "New Document" \
--content "# Document Content\n\nYour content here..."
Output:
✓ Document created
ID: doc_new123
Title: New Document
Workspace: ws_xxx
Create from File
waymaker docs create \
--workspace ws_xxx \
--title "Imported Document" \
--file ./document.md
Create in Project
waymaker docs create \
--workspace ws_xxx \
--project proj_xxx \
--title "Project Document" \
--content "Content here"
Update Document
waymaker docs update <document-id> \
--content "# Updated Content\n\nNew content here..."
Update Title
waymaker docs update <document-id> --title "New Title"
Update from File
waymaker docs update <document-id> --file ./updated-content.md
Options Reference
list
| Option | Type | Description |
|---|---|---|
--workspace | string | Required. Workspace ID |
--project | string | Filter by project |
--json | flag | Output as JSON |
get
| Option | Type | Description |
|---|---|---|
--content | flag | Output text content only |
--raw | flag | Output raw JSON content |
--json | flag | Output as JSON |
create
| Option | Type | Description |
|---|---|---|
--workspace | string | Required. Workspace ID |
--project | string | Project ID |
--title | string | Required. Document title |
--content | string | Document content (markdown) |
--file | string | Read content from file |
update
| Option | Type | Description |
|---|---|---|
--title | string | New title |
--content | string | New content (markdown) |
--file | string | Read content from file |
AI Agent Workflow
# List all documents
DOCS=$(waymaker docs list --workspace ws_xxx --json)
# Get specific document content
DOC_CONTENT=$(waymaker docs get doc_abc123 --content)
# Create a new document with AI-generated content
waymaker docs create \
--workspace ws_xxx \
--title "AI Generated Report" \
--content "$AI_OUTPUT"
# Update existing document
waymaker docs update doc_abc123 \
--content "$(cat updated-content.md)"
MCP Tools (Claude Desktop)
When using the Waymaker MCP server with Claude Desktop or other AI assistants, these tools are available:
commander_document_list
List documents in a workspace with optional filtering.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
workspace_id | string | Yes | Workspace UUID |
folder_id | string | No | Filter to specific folder |
limit | number | No | Maximum documents to return (default: 50) |
sort_by | string | No | Sort field: updated_at, created_at, title |
sort_order | string | No | asc or desc |
Example prompt:
"List all documents in my workspace"
commander_document_get
Retrieve a document by ID with its content.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | Yes | Document UUID |
include_content | boolean | No | Include full content (default: true) |
Example prompts:
"Get the API Spec document and show me its content"
"Read document abc-123 and summarize the key points"
commander_document_create
Create a new document with content.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
workspace_id | string | Yes | Workspace UUID |
title | string | Yes | Document title |
content | object | No | Rich text JSON content structure |
text_content | string | No | Plain text or markdown content |
document_type | string | No | general, session-brief, prd, pattern, runbook, api-doc |
project_id | string | No | Project UUID |
folder_id | string | No | Folder UUID for placement |
status | string | No | draft or published (default: draft) |
Example prompts:
"Create a document titled 'API Design Spec' with the content I just described"
"Create a PRD document called 'Feature X Requirements' and place it in the Design folder"
commander_document_update
Update a document's title, content, status, or location.
Parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
document_id | string | Yes | Document UUID |
title | string | No | New document title |
content | object | No | New Rich text JSON content |
text_content | string | No | New plain text or markdown |
status | string | No | draft or published |
folder_id | string | No | Move to folder UUID |
project_id | string | No | Move to project UUID |
Example prompts:
"Update the API Spec document with the changes we discussed"
"Move the design doc to the Archive folder"
"Change the status of the PRD to published"
Related Commands
- workspaces - Manage workspaces
- projects - Manage projects
- folders - Create and manage folders
- sync - Sync IDE files as documents