azimuth-board 0.0.0-stage → 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Agustín Baffo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,3 +1,55 @@
-# Temporary Holding Version
+# azimuth-board
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The command-line side of [Azimuth](https://azimuth-board.web.app): one screen that tells you
+what's next and what's stuck, for every project you have. The CLI exists so that your AI agents
+(Claude Code, Codex, anything that runs commands) keep the board current while you work.
+
+Needs Node 20 or newer. The command is `azimuth`.
+
+## Connect, once
+
+```bash
+npx -y azimuth-board@latest connect
+```
+
+It opens the board in your browser, you sign in with Google, and the page hands the session to
+the CLI; nothing to copy. It then adds the board rule to your agents' global instructions
+(`~/.claude/CLAUDE.md`, and `~/.codex/AGENTS.md` when you have Codex) and tells you what to do
+next. Run it again whenever you like: it updates in place.
+
+Prefer a global install? `npm install -g azimuth-board`, then `azimuth connect`.
+
+Over SSH, with no browser: in the web app tap **Connect the CLI**, then
+`azimuth connect --token <token>`. The token is your session; keep it secret.
+
+## Then, per repo
+
+```bash
+cd ~/code/robot-garden && azimuth bind robot-garden     # this folder is that project
+```
+
+From then on, agents in that folder run `azimuth next "…"`, `azimuth block <thread> --on "…"`,
+`azimuth wait <thread> --on "…"` and `azimuth done <thread>` when a block of work ends.
+
+## The commands
+
+```
+azimuth list [--area work] [--focus]           the board, same order as the app
+azimuth show [project]                         one project: threads with ids, links, notes
+azimuth next  [project] "<text>" [--note "…"]  set the next step
+azimuth add   [project] "<text>" [--state waiting --on "<who>"] [--note "…"]
+azimuth block [project] <thread> --on "<what>"
+azimuth wait  [project] <thread> --on "<who>"
+azimuth done  [project] <thread>
+azimuth edit / rm / state / note / summary / link / new / prio / hide / unhide / delete
+azimuth bind / unbind / here                   folder ↔ project
+azimuth agents install|uninstall|show          the rule in your agents' instructions
+azimuth export / import                        backup and restore
+azimuth connect / login / logout / whoami / config
+```
+
+`--json` before the command gives structured output. Exit codes: 0 ok, 1 usage, 2 not logged in,
+3 network. A thread is one short line; detail goes in `--note`.
+
+Running your own Azimuth? Point the CLI at it:
+`azimuth config --api-key <web API key> --project-id <project> --app-url https://<your site>`.

package/bin/azimuth.js

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import("../dist/main.js");