10. Getting Started Guide

This guide helps you choose the right approach for your use case and get your first execution running in minutes.

10.1 What Do You Want to Do?

Use the decision tree below to find the best starting point for your goals.

graph TD
    START["What do you want to do?"] --> Q1{"Automate development\nbased on GitHub\nIssues/Projects?"}
    Q1 -- Yes --> ITERATE["Iterate Agent\n(04-iterate-agent-setup)"]
    Q1 -- No --> Q2{"Generate or manage\nprompts from the\ncommand line?"}
    Q2 -- Yes --> CLI["CLI\n(02-climpt-setup / 03-instruction-creation)"]
    Q2 -- No --> Q3{"Use Climpt directly\nfrom Claude Code?"}
    Q3 -- Yes --> PLUGIN["Claude Code Plugin\n(02-climpt-setup)"]
    Q3 -- No --> Q4{"Integrate with\nexternal tools?"}
    Q4 -- Yes --> MCP["MCP\n(07-dependencies)"]
    Q4 -- No --> CONCEPTS["Start with Concepts\n(00-1-concepts)"]

Goal	Approach	Guide
Automated development driven by Issues/Projects	Iterate Agent – autonomous loop that fetches requirements, delegates work, and verifies results	04-iterate-agent-setup
Generate and manage prompts via CLI	CLI – run `climpt` commands to create, build, and output prompts	02-climpt-setup, 03-instruction-creation
Use Climpt inside Claude Code	Claude Code Plugin – install the `climpt-agent` plugin for in-editor prompt access	02-climpt-setup
Connect to external tools	MCP – Model Context Protocol integration for tool interoperability	07-dependencies

10.2 Quick Start by Use Case

Three scenarios to get your first execution in about 5 minutes each.

Scenario A: Generate a Prompt with the CLI

Install, initialize, and generate your first prompt.

# 1. Initialize Climpt in your project
deno run -A jsr:@aidevtool/climpt init

# 2. Verify initialization
ls .agent/climpt/config/

# 3. Display help to see available commands
deno run -A jsr:@aidevtool/climpt --help

# 4. Generate a prompt (example: create an issue prompt)
deno run -A jsr:@aidevtool/climpt to project

Expected output: A Markdown prompt is printed to stdout, ready to be piped or copied.

Scenario B: Use the Claude Code Plugin

Install the plugin and use Climpt commands directly in Claude Code.

# 1. Initialize Climpt in your project (if not done)
deno run -A jsr:@aidevtool/climpt init

Then in Claude Code:

# 2. Add the Climpt marketplace
/plugin marketplace add tettuan/climpt

# 3. Install the plugin
/plugin install climpt-agent

# 4. Verify installation
/plugin list

Expected result: climpt-agent appears in the plugin list and the delegate-climpt-agent Skill becomes available.

Scenario C: Automate an Issue with Iterate Agent

Set up Iterate Agent and let it process a GitHub Issue autonomously.

# 1. Prerequisites: ensure gh is authenticated
gh auth status

# 2. Initialize Climpt (if not done)
deno run -A jsr:@aidevtool/climpt init

# 3. Install the Claude Code plugin (required for Iterate Agent)
# In Claude Code: /plugin marketplace add tettuan/climpt
# In Claude Code: /plugin install climpt-agent

# 4. Initialize Iterate Agent
deno run -A jsr:@aidevtool/climpt/agents/iterator --init

# 5. Run against a specific Issue (replace 123 with your Issue number)
deno run -A jsr:@aidevtool/climpt/agents/iterator --issue 123

Expected result: The agent fetches the Issue, delegates tasks, and iterates until the Issue is resolved. A performance report is displayed on completion.

10.3 Setup Verification Checklist

Confirm each item before proceeding to your chosen workflow.

Required for All Workflows

Deno installed
```
deno --version
```
Expected: deno 2.x.x (2.5 or later)
Climpt initialized
```
ls .agent/climpt/config/
```
Expected: default-app.yml, registry_config.json

Required for Iterate Agent

GitHub CLI installed and authenticated
```
gh auth status
```
Expected: Logged in to github.com as <your-username>
Git repository with GitHub remote
```
git remote -v
```
Expected: an origin remote pointing to github.com
Iterate Agent initialized
```
ls agents/iterator/config.json
```
Expected: config.json exists
Claude Code plugin installed

In Claude Code:
```
/plugin list
```
Expected: output contains climpt-agent

Required for MCP Integration

MCP configuration present
```
ls .agent/climpt/config/
```
Expected: MCP-related configuration files exist

10.4 Next Steps Map

After completing your first execution, choose your next learning path based on your goals.

Your Goal	Next Guide
Create custom instructions (prompts)	03-instruction-creation
Set up and run Iterate Agent	04-iterate-agent-setup
Understand the architecture	05-architecture
Deep dive into configuration files	06-config-files
Learn about dependencies and MCP	07-dependencies
Understand prompt structure and C3L	08-prompt-structure
Create your own custom Agent	13-agent-creation-tutorial

Overview – Guide structure and full table of contents
Concepts – Agent, Runner, Workflow fundamentals
Prerequisites – Deno and gh CLI installation

Support

If you encounter issues, please create an Issue: https://github.com/tettuan/climpt/issues