Skip to content

Synthesys-Lab/agentize

Repository files navigation

AI-powered SDK for Software Development

Tests

Prerequisites

Required Tools

  • Git - Version control (checked during installation)
  • Make - Build automation (checked during installation)
  • Bash - Shell interpreter, version 3.2+ (checked during installation)
  • GitHub CLI (gh) - Required for GitHub integration features
    • Install: https://cli.github.com/
    • Authenticate after installation: gh auth login
    • Used by: /setup-viewboard, /open-issue, /open-pr, GitHub workflow automation
  • Python 3.10+ - Required for permission automation module, otherwise you can have infinite yes to prompt!
    • Use Python venv or anaconda to manage a good Python release!
    • Requires PyYAML (pip install pyyaml) for YAML configuration parsing

Recommended Libraries

  • Anthropic Python Library - For custom AI integrations (optional)
    • Install: pip install anthropic
    • Note: Not required for core SDK functionality, but recommended if you plan to extend or customize AI-powered features

Verification

After installing prerequisites, the installer will automatically verify git, make, and bash availability. GitHub CLI authentication can be verified with:

gh auth status

Quick Start

Agentize is an AI-powered SDK that helps you build your software projects using Claude Code powerfully. It is splitted into two main components:

  1. Claude Code Plugin: Automatically registered during installation when claude CLI is available. See Tutorial 00a: Claude UI Setup for details.
  2. CLI Tool: A source-first CLI tool to help you manage your projects using Agentize. See Tutorial 00: CLI Quickstart for the CLI workflow.
curl -fsSL https://raw.githubusercontent.com/SyntheSys-Lab/agentize/main/scripts/install | bash

Then add to your shell RC file (~/.bashrc, ~/.zshrc, etc.):

source $HOME/.agentize/setup.sh

See docs/feat/cli/install.md for installation options and troubleshooting.

Upgrade: Run lol upgrade to pull the latest changes.

Your First 15 Minutes

After installation, the installer creates ~/.agentize.local.yaml in your home folder. This file controls which AI backends are used for planning and implementation.

The 5-Step Agentize CLI Workflow

  1. Configure (already done) - confirm ~/.agentize.local.yaml exists and adjust backends if needed

  2. Clone with worktrees:

    wt clone https://github.com/org/repo.git myproject.git

    wt clone sets up a bare repository and leaves you in trees/main.

  3. Plan your first feature:

    lol plan --editor

    Review the GitHub issue it creates.

  4. Implement the plan:

    lol impl <issue-number>
  5. Navigate between worktrees:

    wt goto <issue-number>
    wt goto main

See Tutorial 00: CLI Quickstart for a full walkthrough.

Troubleshoot

If you encounter any issue during the usage. For example:

  1. It asks you for permission on a really simple operation.
  2. It fails to automatically continue on a session.

Enable debug mode in your .agentize.local.yaml:

handsoff:
  debug: true

Then re-run the command. This will give you a detailed log in either

  • /path/to/your/project/.tmp/handsoff-debug.log or
  • $HOME/.agentize/.tmp/handsoff-debug.log Paste your logs on issue for me (@were) to debug!

For further help, please visit our troubleshooting guide.

Core Philosophy

Minimizing human intervention by artifact centric.

  • Session-centric: People tell AI what to do, and wait until it ends. Then give feedback until they are satisfied. Human looping in too much limits the scalability.
  • Artifact-centric: People tell AI what to do, and AI produces a plan first. Plan is the ONLY phase that human can intervene. After the plan is approved, AI will execute the plan and produce the code merge for human to review.

A clear separation between human, AI, and formal language.

  • Humans are for the intention of development, including providing feature requirements, approving plans, and code merges.
  • AI is the worker of software development for both making the plan, and maintaining the codebase, including tests, documentation, and code quality.
  • Formal language is for the coordination and orchestration between AI, and other systems, e.g. Github Issues, Pull Requests, and CI/CD pipelines.
    • I (@were) found that skills are promising for AI to synthesize fixed code to interact with such systems, but these flows are more fixed and formal than I expected --- putting them in formal language (e.g. Python scripts, or YAML configuration) is more transparent and faster to execute the whole workflow.

Workflow:

See our detailed workflow diagrams:

Legend: Red boxes represent user interventions (providing requirements, approving/rejecting results, starting sessions). Blue boxes represent automated AI steps.

Tutorials

Learn Agentize in 15 minutes with our step-by-step tutorials (3-5 min each):

  1. CLI Quickstart - Learn the core CLI workflow in 15 minutes
  2. Claude UI Setup - Set up the Claude Code plugin and slash commands
  3. Ultra Planner - Primary planning tutorial (recommended)
  4. Issue to Implementation - Complete development cycle with /issue-to-impl and /code-review
  5. Advanced Usage - Scale up with parallel development workflows

Project Organization

agentize/
├── .claude-plugin/         # Plugin root (use with --plugin-dir)
│   ├── marketplace.json    # Plugin manifest
│   ├── commands/           # Claude Code commands
│   ├── skills/             # Claude Code skills
│   ├── agents/             # Claude Code agents
│   └── hooks/              # Claude Code hooks
├── python/                 # Python modules (agentize.*)
├── docs/                   # Documentation
│   └── git-msg-tags.md     # Commit message conventions
├── src/cli/                # Source-first CLI libraries
│   ├── wt.sh               # Worktree CLI library
│   └── lol.sh              # SDK CLI library
├── scripts/                # Shell scripts and wrapper entrypoints
├── templates/              # Templates for SDK generation
├── tests/                  # Test cases
├── Makefile                # Build targets for testing and setup
└── README.md               # This readme file

About

AI-powered SDK for Software Development

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 8