@shipfoundry/cli 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ShipFoundry contributors
+
+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

@@ -0,0 +1,44 @@
+# ShipFoundry CLI
+
+Manage projects, recommendations, briefs and outcomes from your terminal or an
+agent workflow. Requires Node.js 22 or newer. No runtime dependencies.
+
+## Install
+
+This release candidate is not published yet. Install the supplied
+`shipfoundry-cli-0.1.0.tgz` in a separate directory:
+
+```bash
+bun add ./shipfoundry-cli-0.1.0.tgz
+./node_modules/.bin/shipfoundry --help
+```
+
+The planned registry package is `@shipfoundry/cli`; the command is `shipfoundry`.
+Registry installation instructions will be added once publication is verified.
+The installed CLI works without the ShipFoundry application source tree.
+
+Read the [CLI guide](https://shipfoundry.ai/docs/cli) for commands and the
+[agent setup guide](https://shipfoundry.ai/docs/agent-setup) for onboarding.
+
+## Configuration
+
+Precedence: explicit option, environment, then non-secret profile. A base URL is required; there is no default production destination.
+
+- `SHIPFOUNDRY_API_KEY` (canonical) or legacy `SHIPFOUNDRY_MCP_TOKEN`. The legacy variable name grants nothing extra: its value must be a key with explicit Developer API resource permission. Old MCP-only keys and MCP OAuth tokens do not work with the API.
+- `SHIPFOUNDRY_BASE_URL`, `--base-url`, profile `baseUrl` in `~/.config/shipfoundry/config.json` (base URL only, never secrets), required. There is no default production destination.
+- Plain HTTP is allowed only for loopback development endpoints. Credential-bearing redirects are refused.
+
+Key setup is dashboard-bootstrapped; run `shipfoundry auth login` for the path. The CLI never mints keys and never persists secrets.
+
+## Output and exits
+
+- `--json` emits structured data on stdout; progress and diagnostics go to stderr.
+- Reads never prompt. Every write requires `--yes`; nothing hangs on a TTY prompt.
+- `--wait` (briefs request, operations wait) is bounded; on timeout or interruption the operation ID is reported so another process can resume.
+- Idempotency keys are preserved across retries: pass `--idempotency-key` explicitly for automation.
+- Exits: 0 ok, 2 usage, 3 auth, 4 forbidden, 5 not found, 6 conflict, 7 quota/rate-limit, 8 transient, 9 wait timeout.
+
+## License
+
+MIT. The license covers this CLI package only. It does not license the
+ShipFoundry hosted service or application repository.

package/bin/shipfoundry.mjs

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+import { main } from "../src/main.mjs";
+
+const code = await main(process.argv.slice(2));
+process.exitCode = code;

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@shipfoundry/cli",
+  "version": "0.1.0",
+  "description": "Manage ShipFoundry projects, recommendations, briefs and outcomes from your terminal.",
+  "type": "module",
+  "bin": {
+    "shipfoundry": "./bin/shipfoundry.mjs"
+  },
+  "files": [
+    "bin/",
+    "src/",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22.0.0"
+  },
+  "scripts": {
+    "test": "node --test \"test/*.test.mjs\"",
+    "smoke": "node ./bin/shipfoundry.mjs doctor --json"
+  },
+  "license": "MIT",
+  "homepage": "https://shipfoundry.ai/docs/cli",
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  }
+}