Skip to content

Installation

Get started with agentic15-claude-zen in under 5 minutes.

Prerequisites

Before installing Claude Zen, ensure you have:

  • Node.js 18.0.0 or higher
  • Git installed and configured
  • Platform CLI (choose one):
    • gh (GitHub CLI) for GitHub integration
    • az (Azure CLI) for Azure DevOps integration
  • Claude Code (latest version recommended)

Quick Start

The fastest way to get started with Claude Zen:

Terminal window
npx @agentic15.com/agentic15-claude-zen my-project
cd my-project

This command will:

  1. Create a new project directory
  2. Set up the .claude/ configuration
  3. Initialize git repository
  4. Configure project structure

Authentication

After project setup, authenticate with your platform:

For GitHub

Terminal window
npx agentic15 auth

For Azure DevOps

Terminal window
az login
az devops login

Verify Installation

Check that Claude Zen is working:

Terminal window
npx agentic15 status

You should see your project status displayed.

Configuration

Claude Zen creates a .claude/settings.json file with default configuration:

{
"permissions": {
"allow": ["Read(**)", "Glob", "Grep"],
"ask": ["Edit(**)", "Write(**)", "Bash(*)"],
"deny": ["Bash(rm -rf:*)"]
},
"sandbox": {
"enabled": true
}
}

You can customize these settings based on your project needs.

Essential Commands

Once installed, use these commands in your workflow:

Terminal window
# Generate or finalize project plans
npx agentic15 plan [requirements]
# Begin the next pending task
npx agentic15 task next
# Stage changes and create PR
npx agentic15 commit
# Sync with main branch after PR merge
npx agentic15 sync
# Capture UI screenshots and error logs
npx agentic15 visual-test <url>
# Display current project status
npx agentic15 status

Development Workflow

Claude Zen follows a simple cycle:

  1. Work on tasks in Claude Code
  2. Run npx agentic15 commit to create PR
  3. Review and merge PR on GitHub/Azure DevOps
  4. Run npx agentic15 sync
  5. Run npx agentic15 task next to continue

Troubleshooting

Git not configured

Ensure Git is configured with your name and email:

Terminal window
git config --global user.name "Your Name"
git config --global user.email "your.email@example.com"

GitHub CLI not installed

For GitHub integration, install the GitHub CLI:

Terminal window
# macOS
brew install gh
# Windows
winget install --id GitHub.cli
# Linux
sudo apt install gh

Azure CLI not installed

For Azure DevOps integration, install the Azure CLI:

Terminal window
# macOS
brew install azure-cli
# Windows
winget install -e --id Microsoft.AzureCLI
# Linux
curl -sL https://aka.ms/InstallAzureCLIDeb | sudo bash

Getting Help