argocd-axi 0.1.0 → 0.1.3

package/README.md

@@ -1,4 +1,12 @@
-# argocd-axi
+<h1 align="center">argocd-axi</h1>
+
+<p align="center">
+  <a href="https://www.npmjs.com/package/argocd-axi"><img alt="npm" src="https://img.shields.io/npm/v/argocd-axi?style=flat-square" /></a>
+  <a href="https://github.com/Dematom1/argocd-axi/actions/workflows/ci.yml"><img alt="CI" src="https://img.shields.io/github/actions/workflow/status/Dematom1/argocd-axi/ci.yml?style=flat-square&label=ci" /></a>
+  <a href="https://github.com/Dematom1/argocd-axi/actions/workflows/release-please.yml"><img alt="Release" src="https://img.shields.io/github/actions/workflow/status/Dematom1/argocd-axi/release-please.yml?style=flat-square&label=release" /></a>
+  <a href="https://img.shields.io/badge/platform-macOS%20%7C%20Linux-blue?style=flat-square"><img alt="Platform" src="https://img.shields.io/badge/platform-macOS%20%7C%20Linux-blue?style=flat-square" /></a>
+  <a href="https://x.com/dematom1"><img alt="X" src="https://img.shields.io/badge/X-@dematom1-black?style=flat-square" /></a>
+</p>
 
 Read-only Argo CD for agents. `argocd-axi` wraps the `argocd` CLI and answers
 the questions an agent asks during a deployment problem (which apps need
@@ -48,17 +56,20 @@ argocd-axi turns that into small, definitive answers:
 - **Never hangs.** Nothing streams or follows; waits are bounded; no prompt can
   block because argocd never gets a stdin.
 
-## Install
+## Quick start
+
+Install the published package:
 
 ```sh
 npm install -g argocd-axi
+argocd-axi setup hooks
 ```
 
-Or run it without installing: `npx -y argocd-axi`.
+Or run without installing: `npx -y argocd-axi`. The session hook requires a global install.
 
 Requirements:
 
-- Node.js 20 or newer.
+- Node.js 22.12 or newer.
 - The [`argocd` CLI](https://argo-cd.readthedocs.io/en/stable/cli_installation/)
   on `PATH`, ideally matching your server's version. Tested with argocd
   v3.3.6. There is no hard minimum; `ctx` and the home view warn when the CLI
@@ -227,8 +238,11 @@ specific app.
 
 ## Development
 
+Build from source and run checks:
+
 ```sh
 npm install
+npm run build
 npm run check   # format, lint, typecheck, tests, skill drift check
 ```
 
@@ -239,6 +253,30 @@ the recorded fixtures in `test/fixtures/`, and each test gets a throwaway
 `HOME`. After changing help text, run `npm run build:skill` to regenerate the
 skill.
 
+## Releases
+
+Releases are cut by [release-please](https://github.com/googleapis/release-please)
+from conventional commits (`feat:`, `fix:`, `docs:`, ...) on `main`. It keeps
+a release PR open that bumps the package version, updates `src/version.ts`,
+and updates `CHANGELOG.md`; merging
+that PR tags the release and publishes it to npm from
+`.github/workflows/release-please.yml` through npm trusted publishing, with
+provenance and no stored npm token. Each release is staged: after the workflow
+runs, approve the staged version with 2FA using `npm stage approve <id>` or
+npmjs.com. The version is not live on npm until approved. `CHANGELOG.md` and
+`.release-please-manifest.json` are generated, so never edit them by hand.
+
+If a release was tagged but its publish failed, re-run the publish on that tag
+(the run must be dispatched on the tag so the provenance names its commit):
+
+```sh
+gh workflow run release-please.yml --ref v0.1.1 -f tag=v0.1.1
+```
+
+A version that is staged but not yet approved does not count as published, so
+re-running would try to stage it again and fail. Approve or discard the staged
+version instead.
+
 ## License
 
 [MIT](LICENSE)

package/ROADMAP.md

@@ -90,7 +90,8 @@ Default list limits, the attention threshold for Progressing apps
 app-of-apps, apps in any namespace) are tuned once the target Argo CD
 instances (version, SSO provider, app count) are known.
 
-## Publishing
+## AXI community catalog
 
-npm publication and submission to the
-[AXI community catalog](https://github.com/kunchenguid/axi) come after v1.
+Submission to the [AXI community catalog](https://github.com/kunchenguid/axi)
+comes after v1. npm releases are automated; see the Releases section in
+[README.md](README.md).

package/dist/src/args.js

@@ -1,5 +1,5 @@
 import { validationError } from "./errors.js";
-import { renderBlocks, renderTextBlock } from "./toon.js";
+import { renderBlocks, renderHelpBlock } from "./toon.js";
 export const BIN = "argocd-axi";
 /** `--context` selects the Argo CD context; it is accepted by every command. */
 export const CONTEXT_FLAG = {
@@ -46,10 +46,10 @@ export function renderCommandHelp(spec) {
     return renderBlocks([
         `usage: ${usageLine(spec)}`,
         `description: ${spec.summary}`,
-        renderTextBlock("args", spec.positionals.map((p) => `<${p.name}>: ${p.description}`)),
-        renderTextBlock("flags", spec.flags.map((f) => `${flagLabel(f)}: ${f.description}`)),
-        renderTextBlock("examples", spec.examples),
-        renderTextBlock("notes", spec.notes ?? []),
+        renderHelpBlock("args", spec.positionals.map((p) => `<${p.name}>: ${p.description}`)),
+        renderHelpBlock("flags", spec.flags.map((f) => `${flagLabel(f)}: ${f.description}`)),
+        renderHelpBlock("examples", spec.examples),
+        renderHelpBlock("notes", spec.notes ?? []),
     ]);
 }
 function findFlag(spec, token) {

package/dist/src/commands/common.js

@@ -3,7 +3,7 @@ import { validateContextName } from "../context.js";
 import { CODES, axiError } from "../errors.js";
 import { redactionNotice } from "../redact.js";
 import { PLANNED_WRITES, REFUSALS } from "../registry.js";
-import { encodeObject, renderBlocks, renderHelp, renderTextBlock, } from "../toon.js";
+import { encodeObject, renderBlocks, renderHelp, renderHelpBlock, } from "../toon.js";
 export { CONTEXT_FLAG };
 /** The `--context` flag, validated, ready for `runArgocd` options. */
 export function contextOption(parsed) {
@@ -69,7 +69,7 @@ export async function dispatch(noun, args, subcommands, fallback) {
 function renderGroupHelp(spec, subcommands) {
     return renderBlocks([
         renderCommandHelp(spec),
-        renderTextBlock("subcommands", Object.values(subcommands).map((sub) => `${sub.spec.path}: ${sub.spec.summary}`)),
+        renderHelpBlock("subcommands", Object.values(subcommands).map((sub) => `${sub.spec.path}: ${sub.spec.summary}`)),
         Object.keys(subcommands).length > 0
             ? renderHelp([
                 `Run \`argocd-axi ${spec.path} <subcommand> --help\` for subcommand flags`,

package/dist/src/help.js

@@ -1,4 +1,4 @@
-import { renderBlocks, renderTextBlock } from "./toon.js";
+import { renderBlocks, renderHelpBlock } from "./toon.js";
 export const DESCRIPTION = "Read-only Argo CD for agents: applications needing attention, diffs, history, health, logs, projects and sync windows";
 /** The commands block; the skill is generated from it so the two never drift. */
 export const COMMAND_LINES = [
@@ -24,19 +24,19 @@ export const COMMAND_LINES = [
 export const TOP_HELP = `${renderBlocks([
     "usage: argocd-axi <command> [args] [flags]",
     `description: ${DESCRIPTION}`,
-    renderTextBlock("commands", COMMAND_LINES),
-    renderTextBlock("flags", [
+    renderHelpBlock("commands", COMMAND_LINES),
+    renderHelpBlock("flags", [
         "--context <name>: Argo CD context to target (default: the current context); accepted by every command that reads Argo CD",
         "--help: per-command usage, flags and examples, e.g. `argocd-axi apps view --help`",
         "-v, --version: print the version",
     ]),
-    renderTextBlock("examples", [
+    renderHelpBlock("examples", [
         "argocd-axi",
         "argocd-axi apps --problems",
         "argocd-axi apps view payments-api --context prod",
         "argocd-axi apps diff payments-api",
     ]),
-    renderTextBlock("notes", [
+    renderHelpBlock("notes", [
         "Read-only: v1 never syncs, rolls back, refreshes or deletes; those verbs answer REFUSED with the raw argocd route (writes are on the roadmap)",
         "Output is TOON on stdout, errors included; exit 0 = success (an unhealthy app is data, not an error), 1 = error, 2 = usage",
         "Secret-looking values are redacted and counted; no flag reveals them",

package/dist/src/toon.js

@@ -24,14 +24,17 @@ export function encodeObject(value) {
  * sentences, so help is formatted by hand like other AXI tools do.
  */
 export function renderHelp(lines) {
-    return renderTextBlock("help", lines);
+    return renderHelpBlock("help", lines);
 }
-/** Render multi-line text (logs, diffs, manifests) as an indented block. */
-export function renderTextBlock(label, lines) {
+/** Render help sections as readable indented lines, not data arrays. */
+export function renderHelpBlock(label, lines) {
     if (lines.length === 0)
         return "";
-    const body = lines.map((line) => `  ${line}`).join("\n");
-    return `${label}[${lines.length}]:\n${body}`;
+    return `${label}[${lines.length}]:\n${lines.map((line) => `  ${line}`).join("\n")}`;
+}
+/** Encode multi-line text (logs, diffs, manifests) as a TOON array. */
+export function renderTextBlock(label, lines) {
+    return lines.length === 0 ? "" : encodeObject({ [label]: lines });
 }
 /** Join non-empty TOON blocks into one output string. */
 export function renderBlocks(blocks) {

package/dist/src/version.js

@@ -1,3 +1,3 @@
 // Leaf module: node builtins only, so the bin fast path can answer
 // `--version` without loading the command graph.
-export const VERSION = "0.1.0";
+export const VERSION = "0.1.3"; // x-release-please-version

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "argocd-axi",
-  "version": "0.1.0",
+  "version": "0.1.3",
   "description": "Agent-ergonomic, read-only Argo CD CLI - AXI-compliant argocd wrapper with token-efficient TOON output",
   "type": "module",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "ROADMAP.md"
   ],
   "engines": {
-    "node": ">=20"
+    "node": ">=22.12"
   },
   "publishConfig": {
     "access": "public"
@@ -66,6 +66,6 @@
     "prettier": "3.9.10",
     "typescript": "5.9.3",
     "typescript-eslint": "8.72.1",
-    "vitest": "3.2.7"
+    "vitest": "^5.0.5"
   }
 }