ArtQ

Documentation

Install the CLI and generate your first handoff package.

ArtQ runs in your terminal. Install the CLI, run arch init, and get an implementation-ready project package—no web app required.

Install CLIView pricing

Quickstart

Six steps to your first architecture files.

Create an account, install the CLI, run arch init, and review your generated files.

  1. 1

    Create account

    Sign up to manage billing and plan settings. Optional—the CLI runs locally without signing in.

  2. 2

    Install CLI

    Add the CLI globally with your package manager of choice.

    npm install -g @arch/cli
  3. 3

    Run arch init

    Start an interactive session in any directory. Answer guided questions about scope, users, and constraints.

    arch init
  4. 4

    Generate the handoff package

    The CLI writes implementation-ready artifacts plus a handoff/ folder to guide developers and coding agents (e.g. ./invoice-api/).

  5. 5

    Review the output

    Start at handoff/README.md, then architecture.md and implementation-plan.md before handing off to your coding agent.

  6. 6

    Upgrade later if needed

    Free includes Simple Project mode. Upgrade to Pro when you need advanced methods and deeper interviews.

Install

Install the CLI.

Requires Node.js 18+ and a package manager. Install globally, then run arch init from any directory.

Global install

npm
npm install -g @arch/cli
pnpm
pnpm add -g @arch/cli
bun
bun add -g @arch/cli

Start a project

arch init

Runs an interactive interview and writes files to a folder named after your project (e.g. ./invoice-api/).

First run

What a session looks like.

ArtQ asks concrete questions—not open-ended prompts. Your answers shape the generated files.

terminal
$ arch init
— Project context —
? Project name
  invoice-api
? What are you building?
  REST API for invoicing with Stripe webhooks
? What must the MVP achieve?
  Freelancers can send and get paid on invoices in under 5 minutes
— Scope and boundaries —
? What's in scope for v1?
  Create invoice, Stripe payment, PDF export
Generating handoff package...
✓ invoice-api/handoff/README.md
✓ invoice-api/architecture.md
✓ invoice-api/implementation-plan.md
✓ invoice-api/test-plan.md
✓ invoice-api/review-checklist.md
Done. Start at handoff/README.md, then pass the package to your coding agent.

Files are written to a folder named after your project (e.g. ./invoice-api/). Open handoff/README.md first, then pass the package to your coding agent.

Project handoff package

Implementation-ready artifacts, one clear plan.

Every session produces core docs plus a handoff/ folder to orient developers and coding agents. Content depth depends on your plan and method.

handoff/README.md
Entry point for the handoff package — reading order, agent instructions, and how to navigate the output.
architecture.md
System boundaries, components, data flow, and key decisions. The source of truth before you write code.
implementation-plan.md
Phased tasks with dependencies and acceptance criteria. What to build, in what order.
test-plan.md
Unit, integration, and E2E test scope. Defines what 'done' means for each feature.
review-checklist.md
Pre-ship review items for architecture alignment, security, and DX. Catch drift before merge.

Methods

Pick a workflow for your project type.

Simple Project is free. Advanced methods require Pro.

  • Simple Project

    free

    Lean flow for MVPs, CRUD apps, and small features. ~10 guided questions.

  • Harness Architecture

    pro

    Structures projects for coding agents with clear boundaries and handoff points.

  • TDD Architecture

    pro

    Behavior specs and test boundaries defined before implementation.

  • Clean Architecture

    pro

    Explicit domain, use case, and adapter layers for maintainable codebases.

Select a method with --method on init. See pricing for Pro methods.

FAQ

Common questions.

Do I need the web app?
No. Install the CLI and run projects from your terminal. The web app is only for account and billing management.
Is this a coding assistant?
No. ArtQ runs before you code—it helps you define architecture and plan. Use a coding agent afterward with the generated files.
Can I use the output with any coding agent?
Yes. All output is plain markdown. Drop architecture.md and implementation-plan.md into Cursor, Claude Code, Copilot, or any agent context.
Will there be a VS Code extension?
Planned for later. Today the CLI and local markdown files are the full workflow. An extension would surface artifacts inside the editor.

Ready to plan your next project?

Install the CLI and run a Simple Project free. No credit card required.

Install CLICreate account
npm install -g @arch/cli