Metadata-Version: 2.4
Name: relic-cli
Version: 0.5.0
Summary: Spec-driven development with a shared artifact layer
Project-URL: Homepage, https://github.com/filipefpaulo/relic
Project-URL: Repository, https://github.com/filipefpaulo/relic
License-Expression: MIT
Keywords: ai,cli,llm,spec-driven
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Software Development :: Build Tools
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# relic-cli

> Spec-driven development with a shared artifact layer — Python / uv distribution.

Relic connects all your specs through a shared "brain" of domains, contracts, rules, and assumptions. Intersection detection between specs. Specs that stay alive through bug fixes.

This package ships a **pre-compiled native binary** — no Node.js or Python runtime required at execution time.

---

## Install

```bash
uv tool install relic-cli
```

Or with pip:

```bash
pip install relic-cli
```

---

## Getting started

```bash
cd my-project
relic init

# Open your AI agent (Claude Code, Copilot, Codex) and run:
# Existing codebase:  /relic.scan  then  /relic.constitution
# New project:        /relic.constitution  then  /relic.specify
```

---

## CLI commands

| Command | Purpose |
|---|---|
| `relic init [--engine claude\|copilot\|codex] [--dir] [--force]` | Scaffold `.relic/` in your project |
| `relic add-engine <engine>` | Add AI engine hooks to an existing project |
| `relic use <spec-id>` | Set the active spec for this session |
| `relic scan [--json]` | Output a project manifest for `/relic.scan` |
| `relic context [--spec id] [--text]` | Resolve active spec and report file/artifact status |
| `relic scaffold [--title t\|--spec id]` | Ensure spec folder exists; create from templates if new |
| `relic validate [--text]` | Check artifact integrity and ownership conflicts |
| `relic search <keywords...>` | Search shared artifact manifests by keyword tags |
| `relic deep-search` | Return all manifest entries consolidated (tldr-first triage) |

---

## AI slash commands

Written to your agent's hooks directory by `relic init`:

| Slash command | Purpose |
|---|---|
| `/relic.constitution` | Extract project-specific principles from the codebase |
| `/relic.scan` | Bootstrap shared artifacts from existing code |
| `/relic.specify` | Create a new spec |
| `/relic.clarify` | Append details or change contracts |
| `/relic.plan` | Create an implementation plan |
| `/relic.analyse` | Non-destructive consistency check |
| `/relic.tasks` | Generate tasks from the plan |
| `/relic.implement` | Build the plan |
| `/relic.fix` | Fix a bug constrained by the original spec |
| `/relic.use` | Switch active spec from inside the AI session |

---

## Platform support

Pre-compiled binaries are shipped for:

| Platform | Architecture |
|---|---|
| Linux | x86_64, arm64 |
| macOS | x86_64 (Intel), arm64 (Apple Silicon) |
| Windows | x86_64 |

---

## Also available via npm

```bash
npm install -g relic-cli   # requires Node.js 18+
npx relic-cli init
```

---

[Full documentation](https://github.com/filipefpaulo/relic) · [Report an issue](https://github.com/filipefpaulo/relic/issues)
