@spendgraph/cli 0.2.0 → 0.3.0

package/README.md

@@ -3,6 +3,10 @@
 `sg` drives the spendgraph dashboard from a terminal: write a prompt, declare a
 tool, mint a key, read what a project spent.
 
+```sh
+npm install -g @spendgraph/cli   # or: npx @spendgraph/cli --help
+```
+
 It is a front-end over `@spendgraph/sdk` and nothing else. Every command is one
 SDK call, so the base URL, auth, retries and error shapes are decided in one
 place and this package only decides what to call and how to print it.
@@ -147,3 +151,7 @@ An existing `SKILL.md` is left alone unless `--force` says otherwise.
 
 The difference between 1 and 2 is worth scripting against: a 2 never reached the
 network, so retrying it changes nothing.
+
+## License
+
+MIT

package/dist/args.js

@@ -1,11 +1,4 @@
 const isFlag = (token) => token.startsWith("--");
-/**
- * Splits argv into words and flags.
- *
- * `--name value`, `--name=value` and a bare `--name` all set `name`; `--no-name`
- * clears it. A value starting with a single dash is still a value, so a negative
- * number reaches the command rather than being read as the next flag.
- */
 export function parse(argv) {
     const words = [];
     const flags = {};

package/dist/cli.js

@@ -9,12 +9,6 @@ import { groupHelp, overview } from "./help.js";
 import { render } from "./output.js";
 import { commandNamed, groupNamed } from "./registry.js";
 const HINT = "A dashboard session is needed: for everything under key, project, pricing and credential, and for every write to a prompt or a tool. An sg_ key reads prompts and tools and writes usage. Set SPENDGRAPH_SESSION.";
-/**
- * Runs one command line and returns the exit code.
- *
- * 0 is a reply, 1 is the server refusing, 2 is the line being wrong — so a
- * script can tell a bad request from a bad password without parsing text.
- */
 export async function main(argv, io, opts = {}) {
     const parsed = parse(argv);
     const [groupName, commandName, ...positional] = parsed.words;

package/dist/commands/config.js

@@ -53,7 +53,6 @@ function unset(ctx) {
     writeStore(path, current);
     return { removed: [{ variable, file: path }] };
 }
-/** The global config, and what the CLI resolved from it, a `.env` and the environment. */
 export const config = {
     name: "config",
     summary: "credentials kept globally, and what the CLI resolved",

package/dist/commands/dashboard.js

@@ -11,7 +11,6 @@ function events(ctx) {
         throw new UsageError("--file must hold { events: [...] }.");
     return list;
 }
-/** Projects, their budgets and who is in them. */
 export const projects = {
     name: "project",
     summary: "projects, budgets and members",
@@ -78,7 +77,6 @@ export const projects = {
         },
     ],
 };
-/** API keys. Minting one needs a dashboard session, never a key. */
 export const keys = {
     name: "key",
     summary: "api keys (session only)",
@@ -104,7 +102,6 @@ export const keys = {
         },
     ],
 };
-/** Provider keys the server calls out with. Session only, deliberately. */
 export const credentials = {
     name: "credential",
     summary: "provider keys the server holds (session only)",
@@ -126,7 +123,6 @@ export const credentials = {
         },
     ],
 };
-/** What a model costs, and what the catalogue knows. */
 export const pricing = {
     name: "pricing",
     summary: "model prices, coverage and the catalogue",
@@ -178,7 +174,6 @@ export const pricing = {
         },
     ],
 };
-/** What was spent, by whom, on what. */
 export const spend = {
     name: "spend",
     summary: "usage, stats, events and alerts",

package/dist/commands/prompts.js

@@ -14,7 +14,6 @@ function cases(ctx) {
         throw new UsageError("--file must hold { cases: [...] }.");
     return list;
 }
-/** Stored prompts: writing them, versioning them, running them and reading what they cost. */
 export const prompts = {
     name: "prompt",
     summary: "stored prompts, their versions, datasets and rollouts",

package/dist/commands/skills.js

@@ -24,12 +24,6 @@ function write(ctx, skills) {
         return { skill: skill.name, path, wrote: true };
     });
 }
-/**
- * The `skill` group, which documents itself alongside the groups it is given.
- *
- * Taking the groups as an argument is what keeps the reference generated rather
- * than written down twice: a command added anywhere appears here on the next run.
- */
 export function skillCommands(groups) {
     const self = {
         name: "skill",

package/dist/commands/tools.js

@@ -28,7 +28,6 @@ const saved = (ctx) => scoped(ctx, ctx.body({
     effect: effect(ctx),
     pinned: ctx.bool("pinned") || undefined,
 }));
-/** Tools the model can be offered: declaring them, describing them, retiring them. */
 export const tools = {
     name: "tool",
     summary: "tools the model can be offered",

package/dist/connect.js

@@ -4,12 +4,6 @@ const pick = (parsed, name) => {
     const value = parsed.flags[name];
     return typeof value === "string" ? value : undefined;
 };
-/**
- * Reads the credentials from flags first, the environment second.
- *
- * Both an `sg_` key and a dashboard session may be set. Which half of the API
- * each one opens is the server's decision, not this file's.
- */
 export function credentials(parsed, env = process.env) {
     const baseUrl = pick(parsed, "base-url") ?? env.SPENDGRAPH_BASE_URL;
     if (!baseUrl)
@@ -26,7 +20,6 @@ export function credentials(parsed, env = process.env) {
         project: pick(parsed, "project") ?? env.SPENDGRAPH_PROJECT,
     };
 }
-/** The client every command runs against. `fetch` is injected by tests. */
 export function connect(creds, fetchImpl) {
     return new Spendgraph({
         baseUrl: creds.baseUrl,

package/dist/context.js

@@ -1,6 +1,5 @@
 import { readFileSync } from "node:fs";
 import { UsageError } from "./errors.js";
-/** Builds the `Ctx` a command runs against. `sg` is null for a command that stays local. */
 export function context(sg, parsed, positional, loaded) {
     const flag = (name) => {
         const value = parsed.flags[name];
@@ -76,12 +75,6 @@ function fileBody(path) {
         throw new UsageError(`--file ${path} is not a JSON object.`);
     }
 }
-/**
- * A save body with its `projectId` settled.
- *
- * `--file` carrying one is enough on its own, so a definition checked into a
- * repo applies without the project being named twice.
- */
 export function scoped(ctx, body) {
     return typeof body.projectId === "string" && body.projectId
         ? body

package/dist/env.js

@@ -2,12 +2,6 @@ import { existsSync, readFileSync } from "node:fs";
 import { dirname, join, resolve } from "node:path";
 import { UsageError } from "./errors.js";
 const QUOTED = /^(['"])([\s\S]*)\1$/;
-/**
- * Parses a `.env`: `KEY=value`, one per line.
- *
- * `export` prefixes, `#` comments, blank lines and surrounding quotes are all
- * accepted, because every one of them appears in a file somebody wrote by hand.
- */
 export function parseEnv(text) {
     const out = {};
     for (const raw of text.split(/\r?\n/)) {
@@ -24,7 +18,6 @@ export function parseEnv(text) {
     }
     return out;
 }
-/** The nearest `.env` at or above `from`, or undefined where there is none. */
 export function findEnvFile(from) {
     let dir = resolve(from);
     for (;;) {
@@ -37,13 +30,6 @@ export function findEnvFile(from) {
         dir = parent;
     }
 }
-/**
- * The environment a command runs against, layered.
- *
- * Highest wins: the real environment, then the nearest `.env`, then the global
- * config. A variable already exported is never quietly overruled by a file, and
- * a project's `.env` beats a global default the same way a local git config does.
- */
 export function loadEnv(layers) {
     const { cwd, base, explicit, store } = layers;
     const file = explicit ? resolve(explicit) : findEnvFile(cwd);

package/dist/errors.js

@@ -1,3 +1,2 @@
-/** A message meant for the user rather than a stack trace. */
 export class UsageError extends Error {
 }

package/dist/help.js

@@ -1,6 +1,5 @@
 import { GROUPS } from "./registry.js";
 const pad = (text, width) => text.padEnd(width);
-/** What `sg` alone prints: the groups, and how to prove who you are. */
 export function overview() {
     const width = Math.max(...GROUPS.map((group) => group.name.length));
     return [
@@ -25,7 +24,6 @@ export function overview() {
         "Run `sg <group>` to list its commands.",
     ].join("\n");
 }
-/** What `sg <group>` prints. */
 export function groupHelp(group) {
     const width = Math.max(...group.commands.map((command) => command.name.length));
     return [

package/dist/output.js

@@ -37,13 +37,6 @@ function table(list) {
         ...(hidden > 0 ? [`(${hidden} more ${hidden === 1 ? "column" : "columns"} — use --json)`] : []),
     ].join("\n");
 }
-/**
- * Renders a reply for a terminal, or as JSON where `--json` asked for it.
- *
- * A list of flat rows becomes a table because that is what a person reads;
- * anything else stays JSON rather than being flattened into a shape that hides
- * a nested field.
- */
 export function render(value, json) {
     if (json)
         return JSON.stringify(value, null, 2);

package/dist/registry.js

@@ -4,9 +4,6 @@ import { prompts } from "./commands/prompts.js";
 import { skillCommands } from "./commands/skills.js";
 import { tools } from "./commands/tools.js";
 const RESOURCES = [prompts, tools, projects, keys, credentials, pricing, spend, config];
-/** Every group the CLI offers, in the order help lists them. */
 export const GROUPS = [...RESOURCES, skillCommands(RESOURCES)];
-/** The group by that name, or undefined. */
 export const groupNamed = (name) => GROUPS.find((group) => group.name === name);
-/** The command by that name within a group, or undefined. */
 export const commandNamed = (group, name) => group.commands.find((command) => command.name === name);

package/dist/skills.js

@@ -194,7 +194,5 @@ sg prompt put-cases pr_123 --file ./cases.json
 first if you mean to append.
 `,
 });
-/** The skills this CLI ships, with the command reference rendered from the live registry. */
 export const catalogue = (groups) => [operating(groups), authoring()];
-/** One skill as the SKILL.md file an agent loads. */
 export const document = (skill) => `---\nname: ${skill.name}\ndescription: ${skill.description}\n---\n\n${skill.body}`;

package/dist/store.js

@@ -2,19 +2,16 @@ import { chmodSync, existsSync, mkdirSync, readFileSync, writeFileSync } from "n
 import { homedir } from "node:os";
 import { dirname, join } from "node:path";
 import { UsageError } from "./errors.js";
-/** The variables the global config may hold. Nothing else is written. */
 export const SETTABLE = [
     "SPENDGRAPH_BASE_URL",
     "SPENDGRAPH_API_KEY",
     "SPENDGRAPH_SESSION",
     "SPENDGRAPH_PROJECT",
 ];
-/** Where the global config lives: `$XDG_CONFIG_HOME/spendgraph/config.json`, or under `~/.config`. */
 export function storePath(env = process.env) {
     const base = env.XDG_CONFIG_HOME || join(env.HOME || homedir(), ".config");
     return join(base, "spendgraph", "config.json");
 }
-/** What the global config holds, or nothing where there is no file. */
 export function readStore(path) {
     if (!existsSync(path))
         return {};
@@ -32,12 +29,6 @@ export function readStore(path) {
         .filter(([key]) => SETTABLE.includes(key))
         .map(([key, value]) => [key, String(value)]));
 }
-/**
- * Writes the global config, readable only by its owner.
- *
- * It holds an API key, so the mode is set after the write as well as during it —
- * an existing file keeps whatever mode it already had otherwise.
- */
 export function writeStore(path, values) {
     mkdirSync(dirname(path), { recursive: true });
     const kept = Object.fromEntries(Object.entries(values).filter(([, value]) => value));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@spendgraph/cli",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Drive the spendgraph dashboard from a terminal: prompts, tools, projects, keys and spend.",
   "license": "MIT",
   "repository": {
@@ -37,11 +37,11 @@
     "README.md"
   ],
   "scripts": {
-    "build": "tsc -p tsconfig.json",
+    "build": "tsc -p tsconfig.json --emitDeclarationOnly && tsc -p tsconfig.json --declaration false --removeComments",
     "test": "vitest run"
   },
   "dependencies": {
-    "@spendgraph/sdk": "^0.2.0"
+    "@spendgraph/sdk": "^0.3.0"
   },
   "devDependencies": {
     "typescript": "^5"