Joan Workflow
This skill should be used when the user asks about "joan", "pods", "workspace", "domain knowledge".
Installation
npx clawhub@latest install joan-workflowView the full skill documentation and source below.
Documentation
Joan Workflow
Joan is a workspace-based knowledge and task management system for AI-assisted development. This skill covers when and how to use Joan's core concepts.
Core Concepts
Workspaces
Workspaces are the top-level organizational unit in Joan. Each workspace contains:
- Pods: Versioned domain knowledge documents
- Todos: Tasks scoped to the workspace
- Plans: Implementation specs linked to todos
- Members: Team members with roles (admin, member)
Pods
Pods are versioned markdown documents containing domain knowledge. Use pods to:
- Document project architecture and design decisions
- Store domain-specific terminology and business rules
- Share knowledge across team members and AI assistants
- Maintain living documentation that evolves with the project
Pod lifecycle:
joan pod create.joan/pods/joan pod pushjoan pod pullTodos
Todos are tasks scoped to a workspace. Use todos to:
- Track work items across team members
- Assign tasks and set priorities
- Link implementation plans to tasks
Todo workflow:
joan todo createjoan todo listPlans
Plans are implementation specs linked to todos. Use plans to:
- Document how a feature will be implemented
- Break down complex tasks into steps
- Share implementation approach with team
CLI Commands Reference
Project Initialization
joan init # Interactive workspace selection
joan init -w <workspace-id> # Non-interactive with specific workspace
joan status # Show project and auth status
Pod Management
joan pod list # List tracked pods
joan pod list --all # List all workspace pods
joan pod add # Add workspace pods to project
joan pod create # Create new pod locally
joan pod pull # Pull pods from server
joan pod push # Push local pods to server
joan pod open # Open pod in browser
Todo Management
joan todo list # List todos for tracked pods
joan todo list --mine # List todos assigned to me
joan todo create # Create new todo
joan todo update <id> # Update todo fields
joan todo archive <id> # Archive completed todo
Plan Management
joan plan list <todo-id> # List plans for a todo
joan plan create <todo-id> # Create implementation plan
joan plan pull <todo-id> # Pull plans from server
joan plan push <todo-id> # Push plans to server
Context Generation
joan context claude # Generate CLAUDE.md with Joan context
When to Use What
Starting a New Project
joan init to connect project to a workspacejoan context claude to inject context into CLAUDE.mdBefore Coding a Feature
joan pod list --alljoan pod addjoan pod pullAfter Completing Work
joan pod push and joan todo pushDocumenting New Knowledge
joan pod createjoan pod pushjoan context claudeMCP Integration
Joan provides an MCP server at with tools:
- list_workspaces - List accessible workspaces
- list_pods - List pods in a workspace
- get_pod - Retrieve pod content
The MCP server uses OAuth 2.1 authentication. Authenticate via the CLI first with joan auth login.
## Project Configuration
Joan stores project config in .joan/config.yaml:
__CODE_BLOCK_5__
Pods are stored locally in .joan/pods/ as markdown files.
## Best Practices
### Pod Authoring
- Use clear, descriptive titles
- Include context about when the knowledge applies
- Keep pods focused on a single domain concept
- Update pods when knowledge evolves
- Reference related pods when helpful
### Todo Management
- Create todos at the right granularity (not too big, not too small)
- Link todos to relevant pods for context
- Update status promptly to keep team informed
- Archive completed todos to reduce noise
### Context Synchronization
- Run joan context claude` after changing tracked pods
- Pull pods before starting significant work
- Push changes promptly to share with team