{"id":50537016,"url":"https://github.com/ehsangazar/compass","last_synced_at":"2026-06-03T17:30:20.540Z","repository":{"id":359109021,"uuid":"1243960354","full_name":"ehsangazar/compass","owner":"ehsangazar","description":null,"archived":false,"fork":false,"pushed_at":"2026-05-20T14:27:20.000Z","size":685,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-20T15:58:36.862Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ehsangazar.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-05-19T20:44:43.000Z","updated_at":"2026-05-20T14:44:42.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/ehsangazar/compass","commit_stats":null,"previous_names":["ehsangazar/compass"],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/ehsangazar/compass","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehsangazar%2Fcompass","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehsangazar%2Fcompass/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehsangazar%2Fcompass/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehsangazar%2Fcompass/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ehsangazar","download_url":"https://codeload.github.com/ehsangazar/compass/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ehsangazar%2Fcompass/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33876327,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-03T02:00:06.370Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2026-06-03T17:30:18.267Z","updated_at":"2026-06-03T17:30:20.515Z","avatar_url":"https://github.com/ehsangazar.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Compass\n\n\u003e AI-native, spec-driven development for your codebase.\n\nCompass turns \"vibe coding\" into traceable engineering. Instead of asking your AI assistant to \"just build it,\" you draft a short **change proposal**, lock down the requirements as **specs**, sketch a **design**, and break it into **tasks**. Compass scaffolds those artifacts, validates them, and feeds enriched instructions to your AI tool (Claude Code, Cursor, Codex, Gemini, and 25+ others) so the implementation phase has a real contract to build against.\n\n## Install\n\n```bash\nnpm i -g @gazarr/compass\n```\n\nRequires Node `\u003e=20.19.0`. Available on npm as [`@gazarr/compass`](https://www.npmjs.com/package/@gazarr/compass).\n\n## 60-second quickstart\n\n```bash\ncd your-project\ncompass init --tools claude        # or: cursor, codex, gemini, all, none\ncompass new change add-user-auth   # scaffolds compass/changes/add-user-auth/\n```\n\nThen in your AI tool of choice, run the installed slash command (Claude Code: `/compass:propose \"Add user auth via OIDC\"`) and let the workflow guide you through proposal, specs, design, and tasks. When the change ships:\n\n```bash\ncompass archive add-user-auth      # merge specs into compass/specs/\n```\n\n## How it works\n\nA **change** is a proposal directory under `compass/changes/\u003cname\u003e/`. The default `spec-driven` schema produces four artifacts:\n\n| Artifact   | Question it answers                       |\n| ---------- | ----------------------------------------- |\n| `proposal` | Why are we doing this? What changes?      |\n| `specs`    | What are the requirements and scenarios?  |\n| `design`   | How will we build it?                     |\n| `tasks`    | Step-by-step checklist for implementation |\n\nEach artifact has an enriched prompt accessible via `compass instructions \u003cartifact\u003e --change \u003cname\u003e`. That prompt is what your AI tool consumes, so you get consistent, structured outputs instead of free-form responses. Once shipped, `compass archive` rolls the change's specs into your project's permanent `compass/specs/` directory, building a living source-of-truth for what the codebase actually does.\n\n## Supported AI tools\n\nPick one or many at `compass init` time:\n\n```\namazon-q, antigravity, auggie, bob, claude, cline, codex, forgecode, codebuddy,\ncontinue, costrict, crush, cursor, factory, gemini, github-copilot, iflow, junie,\nkilocode, kimi, kiro, opencode, pi, qoder, lingma, qwen, roocode, trae, windsurf\n```\n\nEach integration drops the relevant slash commands or skills into the right place (e.g. `.claude/skills/`, `.cursor/rules/`, `.gemini/commands/`).\n\n## Command map\n\n**Scaffolding**\n\n- `compass init` — set up Compass in a project, install AI-tool integrations\n- `compass new change \u003cname\u003e` — create a change proposal directory\n- `compass instructions \u003cartifact\u003e --change \u003cname\u003e` — emit enriched AI prompt for an artifact\n\n**Inspection**\n\n- `compass list` — list active changes (or `--specs` for specs)\n- `compass view` — interactive dashboard\n- `compass show \u003citem\u003e` — render a change or spec\n- `compass status` — artifact completion status for a change\n\n**Validation and lifecycle**\n\n- `compass validate [item]` — schema-check a change or spec\n- `compass archive \u003cchange\u003e` — merge a completed change's specs into the project\n- `compass update` — refresh Compass instruction files after a CLI upgrade\n\n**Configuration**\n\n- `compass config` — view/modify global config\n- `compass schemas` — list workflow schemas\n- `compass schema` — manage schemas (experimental)\n- `compass templates` — show resolved template paths\n- `compass workspace` — set up coordination workspaces\n- `compass completion install` — install shell completions\n- `compass feedback \"\u003cmessage\u003e\"` — submit feedback\n\nRun `compass \u003ccommand\u003e --help` for full options.\n\n## Project status\n\n- Version: see [CHANGELOG.md](./CHANGELOG.md)\n- License: MIT\n- Issues and feedback: \u003chttps://github.com/ehsangazar/compass/issues\u003e\n- Publishing and release flow: [PUBLISHING.md](./PUBLISHING.md)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehsangazar%2Fcompass","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fehsangazar%2Fcompass","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fehsangazar%2Fcompass/lists"}