dedalus-cli 0.0.0-stage → 0.8.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 Dedalus
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,307 @@
-# Temporary Holding Version
+# Dedalus
 
-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.
+This library provides convenient access to the Dedalus REST API from the command line.
+
+The full API of this library can be found in [api.md](./api.md).
+
+<br />
+
+## Contents
+
+- [Installation](#installation)
+- [Usage](#usage)
+- [Image import](#image-import)
+- [Feedback](#feedback)
+- [Staging package testing](#staging-package-testing)
+- [API Reference](./api.md)
+- [Signing In](#signing-in)
+- [File Arguments](#file-arguments)
+- [Shell Completion](#shell-completion)
+- [Manual Pages](#manual-pages)
+- [Authentication](#authentication)
+- [Errors](#errors)
+- [Client Options](#client-options)
+- [Retries and Timeouts](#retries-and-timeouts)
+- [Pagination](#pagination)
+- [Helpers](#helpers)
+- [Logging](#logging)
+- [Requirements](#requirements)
+
+<br />
+
+## Installation
+
+```sh
+# npm (requires Node.js)
+npm install -g dedalus-cli
+
+# Homebrew — standalone binary, no Node.js required
+brew install dedalus-labs/tap/dedalus
+
+# Direct download — standalone binary, no Node.js required
+curl -fsSL "https://github.com/dedalus-labs/dedalus-cli/releases/latest/download/dedalus-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/x64/;s/aarch64/arm64/').tar.gz" | tar xz dedalus
+sudo mv dedalus /usr/local/bin/
+
+# Windows — download and extract dedalus-windows-x64.zip, then add it to PATH
+# https://github.com/dedalus-labs/dedalus-cli/releases/latest/download/dedalus-windows-x64.zip
+```
+
+### Upgrading
+
+Run `dedalus upgrade --check` to check for a release, then `dedalus upgrade` to
+install it. Package-manager installations use their owning manager. Standalone
+macOS and Linux installations download the release archive and verify its
+`checksums.txt` before replacing the executable.
+
+If your CLI does not recognize `dedalus upgrade`, reinstall it using one of the
+methods above. Older Go CLI versions do not support this command.
+
+<br />
+
+## Image import
+
+Save a Docker image as an archive, then import it:
+
+```sh
+docker save my-app:latest -o my-app.tar
+dedalus images import my-app.tar --name my-app --platform linux/amd64
+```
+
+Import hashes and streams the file to signed storage, registers the image, then
+polls until it is ready. Progress goes to stderr; stdout contains one final image
+object. A failed, rejected, or revoked image makes the command exit nonzero.
+
+Use `--no-wait` to return after upload and registration while preparation continues:
+
+```sh
+dedalus images import my-app.tar --name my-app --no-wait
+```
+
+`--wait` is accepted explicitly but is already the default. `--wait-timeout 3600`
+sets the total import budget in seconds; the global `--timeout` remains a per-request
+limit in milliseconds. Timing out or pressing Ctrl-C stops the client and does not
+cancel accepted preparation. Keep the image ID from progress output to check its
+status later. Use `--idempotency-key <key>` to reuse the same import identity when
+retrying the same archive and options.
+
+Archives must be regular, nonempty `docker save` files of at most 5 GiB. This command
+requires the image API to be deployed and enabled for your organization; it does not
+bypass access controls. Shell completion for this custom command is not yet included.
+
+Custom image imports currently require an Ubuntu 24.04 `linux/amd64` Docker-save
+archive. On Apple silicon, build or pull with `--platform linux/amd64` before
+saving the archive. The image provides the filesystem; container entrypoint,
+CMD, environment, working directory, and user settings are not applied. Start
+processes using Machine exec or SSH after the Machine reaches running.
+
+## Usage
+
+```sh
+dedalus [resource] [command] [flags]
+
+dedalus machines create \
+  --x-api-key "$DEDALUS_X_API_KEY" \
+  --autosleep '300s' \
+  --memory-mib '4096' \
+  --storage-gib '10' \
+  --vcpu '1'
+```
+
+Every command accepts the global flags below, so the examples that follow show only what is specific to them.
+
+See the [API reference](./api.md) for every available operation.
+
+<br />
+
+## Signing In
+
+Run `dedalus login` and select “Sign in with a browser” at the prompt.
+
+`dedalus login` signs you in and saves the credential for later commands, so it does not have to be passed every time. It goes into your operating system's credential store — the Keychain on macOS, the system keyring on Linux, Credential Manager on Windows — and falls back to a file in your state directory, readable only by you, when no such store is available. Either way it is filed under the base URL it was captured for, so a credential saved for one host is never sent to another. `dedalus logout` forgets it. It also asks the provider to revoke a saved OAuth token when a revocation endpoint is known. The local copy is removed first, so if the provider cannot be reached the credential is still gone from this machine; the failure is printed as a warning and the command still succeeds. A credential passed with a flag, or set in the environment, still takes precedence over a saved one. Sign-in methods: api-key, x-api-key, oauth-browser. Pass `--flow <name>` to pick one without being asked.
+
+```sh
+dedalus login
+dedalus machines list
+dedalus logout
+dedalus logout --all
+```
+
+<br />
+
+Browser sessions send API requests directly to `https://dcs.dedaluslabs.ai`. API-key authentication uses the same endpoint by default, or your selected API endpoint. Do not combine browser-token flags or environment variables with API-key credentials.
+
+## File Arguments
+
+Any command flag or credential reads its value from a file when the value begins with `@`, so a body field holding a whole document does not have to survive shell quoting. `@file://` always sends the file as text and `@data://` always sends it base64-encoded; a bare `@` lets the file decide. A flag that uploads a file takes its path with or without the `@`. Escape a literal value that begins with `@` as `\@`. The global options (`--base-url`, `--timeout`, `--format` and the rest) are read exactly as written.
+
+```sh
+dedalus COMMAND --FLAG @./body.json
+dedalus COMMAND --FLAG @file://./notes.txt
+dedalus COMMAND --FLAG @data://./logo.png
+dedalus COMMAND --FLAG '\@not-a-file'
+```
+
+<br />
+## Feedback
+
+```sh
+dedalus feedback "Machine creation failed" --include-logs auto
+dedalus feedback "A suggestion" --include-logs false
+dedalus feedback "Connection problem" --include-logs true
+dedalus doctor --json
+```
+
+`--include-logs auto` is the default. It attaches diagnostics from a failed command
+within the last 15 minutes for the same API host, credentials, and organization.
+`false` sends no files; a recent server request receipt may still be included as
+metadata. `true` includes a local runtime and proxy-configuration report even when
+no failed command is available. Proxy values are omitted.
+
+For a failed command, the receipt comes from its last API response, including a
+successful response followed by a local connection failure. A later response
+without a receipt clears the candidate. Successful responses are not reported as
+HTTP failures.
+
+The CLI records command names, route templates, response status, duration, and
+server-issued request IDs under `~/.dedalus/debug`. It excludes command arguments,
+request and response bodies, credentials, terminal output, and workspace files.
+Files expire after 10 days and the directory is capped at 50 MiB. Cleanup runs
+when recording new diagnostics. Each process partition is capped at 1,000 events
+and 10 MiB. Feedback submissions never become diagnostic candidates themselves.
+
+Selected files are rebuilt from permitted fields and sent with their exact byte
+size and SHA-256 digest. HTTP retries reuse one idempotency key. A successful
+response means the report was accepted for delivery; it does not confirm that
+support has received it yet.
+
+## Staging package testing
+
+The `CLI SDK CI` workflow builds a versioned package, installs it in a temporary
+directory, runs the tests against the installed package, and uploads the
+`dedalus-cli-staging` artifact. The artifact contains a `.tgz` and its checksum
+record. This workflow does not publish to npm or Homebrew.
+
+Test packages are marked private and retain the production API default.
+Set `DEDALUS_TEST_BASE_URL` to your test API and pass it explicitly:
+
+```sh
+mkdir -p /tmp/dedalus-feedback-test
+npm install --prefix /tmp/dedalus-feedback-test /absolute/path/to/dedalus-cli-VERSION.tgz
+/tmp/dedalus-feedback-test/node_modules/.bin/dedalus doctor --json
+/tmp/dedalus-feedback-test/node_modules/.bin/dedalus feedback "Staging smoke test" \
+  --include-logs false --base-url "${DEDALUS_TEST_BASE_URL:?Set the test API URL}"
+```
+
+Set `DEDALUS_API_KEY` to a staging credential before submitting. To reproduce CI
+locally, run `pnpm install --frozen-lockfile`, `pnpm build`, and `pnpm test:package`.
+Custom feedback code lives under `src/feedback` and is integrated on `scalar-next`.
+Validate Scalar regeneration there before promoting a release.
+
+## Shell Completion
+
+`dedalus completion <shell>` prints a completion script for bash, zsh, and fish. Add the matching line to your shell startup file to complete commands, subcommands, and flags with Tab.
+
+```sh
+# bash (~/.bashrc)
+eval "$(dedalus completion bash)"
+
+# zsh (~/.zshrc)
+eval "$(dedalus completion zsh)"
+
+# fish (~/.config/fish/config.fish)
+dedalus completion fish | source
+```
+
+<br />
+
+## Manual Pages
+
+Installing the package globally also installs man pages. `man dedalus` lists every command, and each command has its own page named after the command with spaces and `:` replaced by `-`.
+
+```sh
+man dedalus
+man dedalus-<resource>-<command>
+```
+
+<br />
+
+## Authentication
+
+Pass credentials to the generated client constructor. Environment variables are read automatically when supported by the target runtime.
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `--api-key` | `<value>` | - | Dedalus API key or short-lived delegated access token in Authorization: Bearer \<credential>. Defaults to DEDALUS_API_KEY. |
+| `--x-api-key` | `<value>` | - | Dedalus API key. Alternative to Bearer token. Defaults to DEDALUS_X_API_KEY. |
+
+Declared schemes:
+
+- `ApiKeyAuth` API key in header `x-api-key`
+- `BearerAuth` bearer token
+
+<br />
+
+## Errors
+
+Failed requests print a structured error to standard error and exit with a status that identifies the failure class. The error body carries the API's own `message` plus a stable `code`, the HTTP `status`, the `requestId`, and — where one applies — an actionable `hint`. Usage errors (exit `2`) are reported as a plain message instead, since no request was made. Exit statuses: `0` success, `1` `error`, `2` `usage`, `10` `auth-failed`, `11` `not-found`, `12` `rate-limited`, `13` `client-error`, `14` `server-error`, `15` `connection-error`.
+
+Documented error statuses: `401`, `403`, `409`, `429`, `503`, `default`.
+
+<br />
+
+## Client Options
+
+Configure the generated client by setting any of these options when you create it.
+
+| Option | Type | Default | Description |
+| --- | --- | --- | --- |
+| `--base-url` | `<url>` | - | Override the base URL for API requests. |
+| `--timeout` | `<ms>` | - | Request timeout in milliseconds. |
+| `--max-retries` | `<count>` | - | Number of retries for retryable failures. |
+| `--debug` | `flag` | - | Enable SDK debug logging. |
+
+<br />
+
+## Retries and Timeouts
+
+Generated clients support request timeouts and retry temporary failures such as network errors, 408, 409, 429, and 5xx responses. Retry delays honor `Retry-After` headers when present. Tune the retry and timeout client options shown above, or override them per request.
+
+<br />
+
+## Pagination
+
+Paginated commands fetch subsequent pages for you. Use `--max-items <count>` to cap the total number of items returned.
+
+<br />
+
+## Helpers
+
+- `--format <format>` — output format: `auto`, `json`, `jsonl`, `pretty`, `raw`, `toon`, or `yaml`.
+- `--format-error <format>` — error output format: `auto`, `json`, `jsonl`, `pretty`, `raw`, `toon`, or `yaml`.
+- `--format toon` — token-efficient structured output for AI agents; uniform lists collapse into one header plus a row per item, with a definitive item count.
+- `--transform <path>` and `--transform-error <path>` — dot-path transform for data/error output.
+- `--raw-output`, `-r` — print transformed string values without JSON quotes.
+- `--max-items <count>` — bound iterator, streaming, and WebSocket command output.
+- Errors carry a stable `code` and an actionable `hint` beside the API's own message, and each failure class exits with its own status: `1` `error`, `2` `usage`, `10` `auth-failed`, `11` `not-found`, `12` `rate-limited`, `13` `client-error`, `14` `server-error`, `15` `connection-error`.
+
+<br />
+
+## Logging
+
+- Pass `--debug` to any command to enable SDK debug logging on stderr.
+
+<br />
+
+## Requirements
+
+- Node.js 20 or newer — for the npm install only; the standalone binaries bundle their own runtime.
+
+Powered by Scalar.
+
+<!-- @custom start -->
+### Automatic retry identity
+
+Client-generated idempotency keys use the API's 32-character UUIDv7 format.
+Automatic retries reuse the original key. Independent submissions receive new
+keys, and callers can still supply an explicit key when retrying a saved request.
+<!-- @custom end -->

package/SKILL.md

@@ -0,0 +1,73 @@
+---
+name: dedalus-cli-sdk
+description: "CLI SDK for Dedalus API. Use when writing CLI code that calls Dedalus API with the dedalus-cli package: installing it, constructing and authenticating the client, and calling API operations."
+---
+
+# Dedalus CLI SDK
+
+Generated CLI client for Dedalus API, published as `dedalus-cli`. Use the generated client instead of hand-writing HTTP requests.
+
+## Install
+
+```sh
+# npm (requires Node.js)
+npm install -g dedalus-cli
+
+# Homebrew — standalone binary, no Node.js required
+brew install dedalus-labs/tap/dedalus
+
+# Direct download — standalone binary, no Node.js required
+curl -fsSL "https://github.com/dedalus-labs/dedalus-cli/releases/latest/download/dedalus-$(uname -s | tr '[:upper:]' '[:lower:]')-$(uname -m | sed 's/x86_64/x64/;s/aarch64/arm64/').tar.gz" | tar xz dedalus
+sudo mv dedalus /usr/local/bin/
+
+# Windows — download and extract dedalus-windows-x64.zip, then add it to PATH
+# https://github.com/dedalus-labs/dedalus-cli/releases/latest/download/dedalus-windows-x64.zip
+```
+
+## Client setup and authentication
+
+Provide credentials using the options below. Environment variables are read automatically when the target runtime supports them:
+
+- `--api-key` (env: `DEDALUS_API_KEY`) — Dedalus API key or short-lived delegated access token in Authorization: Bearer <credential>.
+- `--x-api-key` (env: `DEDALUS_X_API_KEY`) — Dedalus API key. Alternative to Bearer token.
+- `--browser-token` (env: `DEDALUS_BROWSER_TOKEN`) — Credential for the BrowserAuth scheme.
+
+## Calling operations
+
+```sh
+dedalus [resource] [command] [flags]
+
+dedalus machines create \
+  --api-key "$DEDALUS_API_KEY" \
+  --autosleep '300s' \
+  --memory-mib '4096' \
+  --storage-gib '10' \
+  --vcpu '1'
+```
+
+Method names, parameter shapes, and response types are generated from the API description — do not guess them. Look up the exact call signature in [api.md](./api.md) before writing a call.
+
+## Pagination
+
+Paginated commands fetch subsequent pages for you. Use `--max-items <count>` to cap the total number of items returned.
+
+## Error handling
+
+Failed requests print a structured error to standard error and exit with a status that identifies the failure class. The error body carries the API's own `message` plus a stable `code`, the HTTP `status`, the `requestId`, and — where one applies — an actionable `hint`. Usage errors (exit `2`) are reported as a plain message instead, since no request was made. Exit statuses: `0` success, `1` `error`, `2` `usage`, `10` `auth-failed`, `11` `not-found`, `12` `rate-limited`, `13` `client-error`, `14` `server-error`, `15` `connection-error`.
+
+## Working with this SDK programmatically
+
+- Pass `--format toon` for token-efficient structured output: a uniform list collapses into one header plus a row per item, with a definitive `[N]` count. Use `--format json` when the output is fed to a JSON parser.
+- Use `--max-items <count>` to bound paginated, streaming, and WebSocket commands before they fill the context, and `--transform <dot.path>` to keep only the field you need.
+- Endpoint commands never prompt, so they are safe to run non-interactively. Credentials come from the documented environment variables or their flags. `login` is meant for a human at a terminal, so do not drive it: a flow that reads a credential refuses a non-terminal stdin outright, and a browser or device flow waits for a person to finish signing in elsewhere before it gives up. Set the credential through its environment variable or flag instead.
+- Branch on the exit status rather than on stderr text: `0` success, `1` `error`, `2` `usage`, `10` `auth-failed`, `11` `not-found`, `12` `rate-limited`, `13` `client-error`, `14` `server-error`, `15` `connection-error`. A failed request repeats its class on stderr as a stable `code`, with a `hint` when there is a concrete next step; exit `2` is a plain message with no structured body, because the command never ran.
+- Run `dedalus --help` or `dedalus <resource> --help` to discover commands and flags, and `man dedalus` for the full reference.
+
+## Requirements
+
+- Node.js 20 or newer — for the npm install only; the standalone binaries bundle their own runtime.
+
+## Reference files
+
+- [README.md](./README.md) — full feature tour: client options, retries and timeouts, logging.
+- [api.md](./api.md) — complete catalogue of every operation with request and response types.