@typeship-ax/cli 0.6.0

package/LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 typeship
+
+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,40 @@
+# @typeship-ax/cli
+
+CLI for typeship. [API reference](./api.md)
+
+Generated from the OpenAPI spec by [typeship](https://typeship.dev). Change the spec or generation settings, then regenerate; generated files are not hand-edited.
+
+- **Zero runtime dependencies** — built on the platform `fetch` (Node 18+, browsers, edge runtimes)
+- **Spec-native CLI** — every operation is a command with typed flags, stable JSON, help, and exit codes
+
+## Install
+
+```sh
+npm install @typeship-ax/cli
+```
+
+## CLI
+
+The package ships `typeship`, a command for every API operation. API commands write JSON to stdout; discovery commands offer `--json`. Exit codes 0/1/2 mean success, request failure, and invalid usage.
+
+```sh
+npm install -g @typeship-ax/cli
+typeship login                      # stores a credential (or set TYPESHIP_TOKEN)
+typeship projects list
+typeship projects list --all | jq -r '.id'   # every page, one item per line
+typeship <resource> <command> --help     # flags, types, an example
+```
+
+CLI conventions:
+
+- Path parameters are positional; query and body fields are flags named after their wire fields.
+- Arrays accept a comma list or repeated flags. Objects accept JSON; `--data @file` and `--data -` read a full body.
+- `--fields id,name` projects results. `--all` streams paginated results as NDJSON.
+- Destructive commands require confirmation or `--force`. Piped errors are stable JSON on stderr.
+
+Auth: `typeship login` stores a credential under `~/.config/typeship/`; the environment (`TYPESHIP_TOKEN`) and flags (`--token`) win over it. `TYPESHIP_BASE_URL` / `--base-url` pick the endpoint.
+
+Useful commands:
+
+- `typeship init` configures credentials and repository agent instructions.
+- `typeship docs search <term> --json`, `typeship doctor`, and `typeship help --json` cover discovery and diagnostics.