Getting Started
Language: English | 日本語 Last updated: 2026-05-31 (updated 2026-05-31: force CF Pages asset re-hash to recover /getting-started/ HTTP 500, #156; 2026-05-28: add existing-project Quick Start + —user guide, #130 PR-3) Audience: New users
This page covers everything you need to start using Aphelion: Claude Code setup, first-run walkthrough, usage scenarios, command reference, and troubleshooting.
Table of Contents
Section titled “Table of Contents”- Prerequisites
- Quick Start
- Existing Project Quick Start
- First Run Walkthrough
- Usage Scenarios
- Command Reference
- What to Expect: A Typical Session
- Troubleshooting
- Related Pages
- Canonical Sources
Prerequisites
Section titled “Prerequisites”| Requirement | Details |
|---|---|
| Claude Code | Claude Code CLI installed and authenticated |
You can install Aphelion via npx github:kirin0198/aphelion-agents init (no clone required), or clone the repository manually:
git clone https://github.com/kirin0198/aphelion-agents.gitQuick Start
Section titled “Quick Start”Install via npx (recommended)
Section titled “Install via npx (recommended)”The fastest way to get started — no cloning required:
# Initial install (into current project)npx github:kirin0198/aphelion-agents init
# Install into user home (~/.claude/)npx github:kirin0198/aphelion-agents init --user
# Update to latestnpx github:kirin0198/aphelion-agents updatenpx github:kirin0198/aphelion-agents update --userCache caveat:
npxcaches packages byname@version. If your local cache holds an older extraction at the same version string,updatewill silently copy that stale snapshot. To force a refresh: pin the source ref (npx github:kirin0198/aphelion-agents#main update) or clear the cache (npm cache clean --force) then re-runupdate. Compare the printedsource: aphelion-agents@<version>against the latestversionin package.json onmainto confirm freshness.
init vs init --user: which should I use?
Section titled “init vs init --user: which should I use?”| Case | Recommended |
|---|---|
| Use in a specific project | init (project-local) |
| Share across multiple projects | init --user (global) |
| Using project-rules.md | Always project-local |
Warning:
project-rules.mdmust be placed in the project’s.claude/rules/directory (project-local). Installing Aphelion withinit --userplaces agents and rules in~/.claude/globally, butproject-rules.mdmust still be generated per project via/aphelion-init. A globally placedproject-rules.mdin~/.claude/rules/can cause unintended behavior across unrelated projects.
Install via git clone (alternative)
Section titled “Install via git clone (alternative)”Clone the repository first:
git clone https://github.com/kirin0198/aphelion-agents.gitThen copy the files manually:
Copy the .claude/ directory to your project and start Claude Code:
cp -r .claude /path/to/your-project/cd /path/to/your-project && claude
/aphelion-init/discovery-flow I want to build a TODO appExisting Project Quick Start
Section titled “Existing Project Quick Start”Already have a codebase? Follow these steps to bring Aphelion in:
Step 1: Install Aphelion
npx github:kirin0198/aphelion-agents init# or: cp -r /path/to/aphelion-agents/.claude /path/to/your-project/Step 2: Set up project-specific rules
/aphelion-initrules-designer generates .claude/rules/project-rules.md for your project. This is required
before running any flow.
Step 3: Generate docs (only if SPEC.md / ARCHITECTURE.md are absent)
/codebase-analyzer Analyze this project and generate SPEC.md and ARCHITECTURE.mdSkip this step if your project already has SPEC.md and ARCHITECTURE.md.
Step 4: Start working
/analyst {issue or feature description}# or/maintenance-flow {trigger description}Use /analyst for a single-issue workflow. Use /maintenance-flow when you want automatic
Patch / Minor / Major triage.
Decision flowchart:
Does your project have SPEC.md and ARCHITECTURE.md?|+-- YES --> /analyst or /maintenance-flow|+-- NO --> /codebase-analyzer --> /analyst or /maintenance-flowFirst Run Walkthrough
Section titled “First Run Walkthrough”This walkthrough uses Claude Code for a new project.
Step 1: Copy Aphelion to your project
cp -r /path/to/aphelion-agents/.claude /path/to/your-project/cd /path/to/your-projectclaudeStep 2: Set up project-specific rules (required)
/aphelion-initrules-designer walks you through language / framework, Git conventions, build commands,
output language, and Co-Authored-By policy, then writes .claude/rules/project-rules.md.
All subsequent agents assume this file exists and read it for project context. Run
/aphelion-help at any time to see every command this repo ships.
Step 3: Start Discovery
/discovery-flow I want to build a task management web app with user authenticationThe orchestrator will ask you several triage questions to determine the plan. For a web app with authentication, it will likely select Standard or Full.
Step 4: Review Discovery output
After all Discovery phases complete, review DISCOVERY_RESULT.md. If you are satisfied, proceed to Delivery.
Step 5: Start Delivery
/delivery-flowThe orchestrator reads DISCOVERY_RESULT.md and performs triage again for the implementation phase.
Step 6: Review and iterate
At each phase, the orchestrator shows you what was generated and asks for approval. You can approve, request modifications, or stop.
Step 7: Start Operations (service only)
/operations-flowOnly needed if PRODUCT_TYPE: service. Builds Dockerfile, CI/CD, and operations plan.
Usage Scenarios
Section titled “Usage Scenarios”Scenario 1: New Project (Full Flow)
Section titled “Scenario 1: New Project (Full Flow)”Start from scratch — requirements through deployment:
/discovery-flow I want to build a blog management systemAfter Discovery completes and you review DISCOVERY_RESULT.md:
/delivery-flowAfter Delivery completes (for service projects):
/operations-flowScenario 2: Quick Build (Delivery Only)
Section titled “Scenario 2: Quick Build (Delivery Only)”When you already know what to build:
/delivery-flow I want to build a REST API for managing contactsThe orchestrator will interview you directly since there is no DISCOVERY_RESULT.md.
Scenario 3: Existing Project with Docs (Bug Fix or Feature)
Section titled “Scenario 3: Existing Project with Docs (Bug Fix or Feature)”Your project has SPEC.md and ARCHITECTURE.md:
/analyst There's a 500 error on the login endpoint when the email contains special charactersAfter analyst generates the GitHub issue and approach document:
/delivery-flowThe flow joins from Phase 3 (architecture), skipping spec and UI design.
Scenario 3b: Maintenance flow with triage (bug / CVE / small feature)
Section titled “Scenario 3b: Maintenance flow with triage (bug / CVE / small feature)”When the change is small and you want automatic triage:
/maintenance-flow Login endpoint returns 500 when email contains special characterschange-classifier analyzes the trigger and proposes Patch / Minor / Major. Patch and Minor complete in a single flow; Major hands off to /delivery-flow automatically via MAINTENANCE_RESULT.md.
Prefer /maintenance-flow over /analyst when:
- The change has urgency (P1/P2 incident)
- You want automatic impact analysis (files, dependencies, regression risk)
- You need guided plan selection rather than a single-issue workflow
Scenario 4: Existing Project without Docs
Section titled “Scenario 4: Existing Project without Docs”See Existing Project Quick Start for the full 4-step guide,
including when to run /codebase-analyzer and how to proceed to /analyst or /maintenance-flow.
Scenario 5: Standalone Agents
Section titled “Scenario 5: Standalone Agents”You can invoke any agent directly without a flow:
/security-auditor (run security audit on existing code)/reviewer (run code review only)/doc-writer (generate README and CHANGELOG)Command Reference
Section titled “Command Reference”| Command | Purpose | Entry Point |
|---|---|---|
/aphelion-init | First-run project rules setup (launches rules-designer) | Right after npx aphelion-agents init |
/aphelion-help | List all Aphelion slash commands | Anytime, in any project |
/aphelion-check | Health check: verify agents, rules, hooks, gh auth, git, Docker | Anytime, in any project |
/discovery-flow {description} | Start requirements exploration | New projects |
/delivery-flow | Start design & implementation | After Discovery, or with existing SPEC.md |
/operations-flow | Start deployment & operations | After Delivery, service type only |
/doc-flow | Generate customer-facing deliverables (HLD / LLD / API reference / ops manual / user manual / handover) | Projects with SPEC.md + ARCHITECTURE.md |
/analyst {issue} | Analyze bugs/features for existing projects | Projects with SPEC.md |
/maintenance-flow {trigger} | Maintenance triage and execution (Patch/Minor/Major) for existing project | Projects with SPEC.md + ARCHITECTURE.md |
/codebase-analyzer {instruction} | Reverse-engineer specs from existing code | Projects without SPEC.md |
/reviewer | Code review against SPEC.md and ARCHITECTURE.md | Projects with SPEC.md |
/tester | Run or generate tests against TEST_PLAN.md | Projects with TEST_PLAN.md |
/rules-designer | Generate or update .claude/rules/project-rules.md interactively | Any project |
/secrets-scan | Grep-based scan for hardcoded secrets in the repo | Any project |
/vuln-scan | Dependency vulnerability scan (tech-stack auto-detected) | Any project |
These commands are defined as slash commands in
.claude/commands/*.md(Claude Code). Run/aphelion-helpfor the canonical, always-up-to-date listing.
What to Expect: A Typical Session
Section titled “What to Expect: A Typical Session”Triage Questions
Section titled “Triage Questions”At flow start, the orchestrator asks 4-6 questions about your project. Answer as accurately as possible — these determine which agents run.
Phase Approvals
Section titled “Phase Approvals”After each agent completes, the orchestrator shows a summary and asks:
- Approve and continue — proceed to the next phase
- Request modification — describe changes and the agent re-runs
- Stop — end the flow
Artifact Files
Section titled “Artifact Files”Each agent generates one or more files:
| Phase | Files Generated |
|---|---|
| Discovery | INTERVIEW_RESULT.md, RESEARCH_RESULT.md, POC_RESULT.md, SCOPE_PLAN.md, DISCOVERY_RESULT.md |
| Delivery | SPEC.md, UI_SPEC.md, ARCHITECTURE.md, TASK.md, implementation code, TEST_PLAN.md, SECURITY_AUDIT.md, README.md |
| Operations | Dockerfile, docker-compose.yml, .github/workflows/ci.yml, DB_OPS.md, OBSERVABILITY.md, OPS_PLAN.md |
Note on TASK.md: TASK.md follows a 3-state lifecycle:
- At phase start —
developergeneratesTASK.mdpopulated with the task checklist fromARCHITECTURE.md. - During the phase —
developerticks completed checkboxes and updates the “Recent Commits” section after each task. - At phase completion —
developerresetsTASK.mdto an empty placeholder so the next phase starts clean. A fully-tickedTASK.mdcommitted tomainis a rule violation (see.claude/rules/document-versioning.md§“TASK.md Lifecycle”); the phase’s analysis and outcome belong indocs/design-notes/<slug>.mdinstead.
An empty TASK.md at the repository root is the correct idle state, not a
sign of incomplete work.
Session Resume
Section titled “Session Resume”If a session is interrupted (especially during developer), you can resume:
/developer (resume from TASK.md)Or restart the entire flow — it will detect existing files and ask if you want to continue or start over.
Troubleshooting
Section titled “Troubleshooting””DISCOVERY_RESULT.md is missing required fields”
Section titled “”DISCOVERY_RESULT.md is missing required fields””Delivery Flow validates DISCOVERY_RESULT.md at startup. If it reports missing fields (PRODUCT_TYPE, “プロジェクト概要”, “要件サマリー”), edit the file to add the missing sections, then re-run /delivery-flow.
”Agent returned STATUS: error”
Section titled “”Agent returned STATUS: error””The orchestrator will present options:
- Retry — re-run the same agent
- Retry with instruction — describe what to fix before retrying
- Skip — skip this agent and continue
- Stop — abort the flow
”Developer is stuck / taking too long”
Section titled “”Developer is stuck / taking too long””developer uses TASK.md to track progress. If a task is taking too long, you can interrupt and resume later. The next run will start from the first incomplete task in TASK.md.
Related Pages
Section titled “Related Pages”Canonical Sources
Section titled “Canonical Sources”- README.md — Project overview and Quick Start
- .claude/commands/ — Slash command definitions
- .claude/agents/discovery-flow.md — Discovery flow startup procedure
- .claude/agents/delivery-flow.md — Delivery flow startup procedure