Skip to main content

Quick Start Guide

Get started with AnyTask CLI in 5 minutes.

🚀 5-Minute Setup

1. Install

# Recommended: Install script
curl -fsSL https://anyt.dev/install.sh | sh
For other installation methods (uv, pipx, pip), see the Installation Guide.

2. Set Up Authentication

Get your agent API key from https://anyt.dev/home/settings/api-keys, then:
# Set your agent API key
export ANYT_API_KEY=anyt_agent_xxxxxxxxxxxxx
Make it persistent - Add to your shell profile:
echo 'export ANYT_API_KEY=anyt_agent_xxxxxxxxxxxxx' >> ~/.zshrc
source ~/.zshrc

3. Initialize Workspace (Interactive)

Navigate to your project and run the interactive setup:
# Navigate to your project
cd /path/to/your/project

# Run interactive initialization (recommended)
anyt init
The interactive setup will:
  • Verify your authentication
  • Show all available workspaces
  • Let you select which workspace to use
  • Show all projects in that workspace
  • Let you select which project to use
  • Save configuration to .anyt/anyt.json
For CI/CD (non-interactive):
# Auto-select first workspace and project
anyt init -y

# Or specify explicitly
anyt init --workspace-id 123 --project-id 5

4. Verify Configuration

# Check API connectivity
anyt health check

# View workspace configuration
cat .anyt/anyt.json

5. Create Your First Task

# Create a task
anyt task add "Implement user authentication" \
  --status todo \
  --priority 1

# Create task with labels
anyt task add "Fix login bug" \
  --status todo \
  --priority 2 \
  --labels bug,urgent

# View all tasks
anyt task list

# View Kanban board
anyt board
🎉 You’re all set! You can now manage tasks with AnyTask CLI.

📋 Common Commands

Task Management

# Create tasks
anyt task add "Task title" --priority 1 --status todo
anyt task add "High priority bug" --priority 2 --labels bug,urgent

# List tasks
anyt task list
anyt task list --status todo
anyt task list --mine

# View task details
anyt task show DEV-123

# Update tasks
anyt task edit DEV-123 --status in_progress
anyt task edit DEV-123 --priority 2
anyt task edit DEV-123 --title "New title"

# Mark as done
anyt task done DEV-123 --note "All tests passing"

# Delete tasks
anyt task rm DEV-123 --force

Active Task Workflow

# Pick a task to work on
anyt task pick DEV-123

# View active task
anyt active

# Mark active task as done
anyt task done

# Add comment
anyt comment add -m "Completed implementation"

Visualization

# Kanban board
anyt board
anyt board --mine
anyt board --compact

# Task details
anyt task show DEV-123

# Dependencies
anyt task dep list DEV-123
anyt graph DEV-123

Task Dependencies

# Add dependency (DEV-124 depends on DEV-123)
anyt task dep add DEV-124 --on DEV-123

# List dependencies
anyt task dep list DEV-124

# Remove dependency
anyt task dep rm DEV-124 --on DEV-123

Comments

# Add comment to active task
anyt comment add -m "Completed implementation"

# Add comment to specific task
anyt comment add DEV-123 -m "Found edge case"

# List comments
anyt comment list DEV-123

🎯 Daily Workflow

Morning Routine

# Check your board
anyt board

# Or view just your tasks
anyt board --mine

# Pick a task to work on
anyt task pick DEV-42

# Task is now marked as your active task
anyt active

During Development

# Check what you're working on
anyt active

# Update task status
anyt task edit DEV-42 --status in_progress

# Add progress notes
anyt comment add -m "Implemented OAuth flow"

# Add notes to specific task
anyt comment add DEV-42 -m "Found edge case with expired tokens"

Completing Tasks

# Mark active task as done
anyt task done --note "All tests passing"

# Or mark specific task as done
anyt task done DEV-42 --note "Deployed to staging"

End of Day

# View what you accomplished
anyt task list --status done --mine

# Check tomorrow's tasks
anyt task list --status todo --mine

🔧 Configuration Tips

Environment Variables

# Set API key
export ANYT_API_KEY=anyt_agent_...

# Set API URL (optional)
export ANYT_API_URL=https://api.anyt.dev

# Set custom config directory (optional)
export ANYT_CONFIG_DIR=~/.config/anyt

Shell Aliases

Add to ~/.bashrc or ~/.zshrc:
alias ab='anyt board'
alias at='anyt task'
alias aa='anyt active'
alias ap='anyt task pick'

🚀 Next Steps

Now that you have the basics, explore more features:

🐛 Troubleshooting

Not authenticated

# Error: ANYT_API_KEY environment variable not set
# Solution: Set the API key
export ANYT_API_KEY=anyt_agent_xxxxxxxxxxxxx

Not in a workspace directory

# Error: Not in a workspace directory
# Solution: Initialize workspace
anyt init --workspace-id 123 --identifier DEV

Connection Issues

# Check API URL
echo $ANYT_API_URL

# Verify backend is running
anyt health check

🤝 Getting Help

# General help
anyt --help

# Command-specific help
anyt task --help
anyt task add --help

# Check version
anyt --version
For more help: