Ixchel

CLI Reference

Comprehensive guide to the ixchel command-line interface

CLI Reference

Ixchel is a single CLI for issues, decisions, reports, and other knowledge artifacts. All commands support --repo (override repo root) and --json (machine-readable output).

Entity Kinds

decision, issue, idea, report, source, citation, agent, session

Global Flags

  • --repo <path>: run against a different repository
  • --json: output JSON for scripting/agents

Commands

ixchel init

Initialize .ixchel/ in the current repo.

ixchel init
ixchel init --force

ixchel create <kind> <title>

Create a new entity. Optionally set status.

ixchel create issue "Add user authentication" --status open
ixchel create decision "Adopt PostgreSQL" --status proposed

ixchel show <id>

Show a single entity by ID.

ixchel show iss-a1b2c3

ixchel list [kind]

List entities (optionally filtered by kind).

ixchel list
ixchel list report

ixchel edit <id>

Open an entity in your $EDITOR.

ixchel edit dec-a1b2c3

ixchel delete <id>

Delete an entity by ID.

ixchel delete idea-a1b2c3

Create a relationship edge.

ixchel link iss-a1b2c3 blocks iss-d4e5f6

Remove a relationship edge.

ixchel unlink iss-a1b2c3 blocks iss-d4e5f6

ixchel search <query>

Search across indexed artifacts.

ixchel search "authentication"
ixchel search "graph storage" --limit 5

ixchel graph <id>

Traverse relationships for an entity.

ixchel graph iss-a1b2c3

ixchel context <id>

Generate AI-ready context for an entity.

ixchel context iss-a1b2c3

ixchel sync

Synchronize git-tracked artifacts with the index.

ixchel sync

ixchel check

Validate entities and relationships.

ixchel check

--json includes an optional suggestion field per error to guide automated fixes.

On this page