@onklave/agent-cli 0.1.7 → 0.1.9

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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 the 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 the 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 any 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
+
+   Copyright 2025-2026 Onklave (Pty) Ltd.
+
+   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

@@ -0,0 +1,305 @@
+# Onklave Agent CLI
+
+The official command-line interface for the [Onklave](https://onklave.app) platform.
+Run AI agent tasks locally with cloud orchestration, policy enforcement, and audit trails.
+
+`@onklave/agent-cli` is the bridge between your terminal and the Onklave platform: it
+authenticates your machine, ships agent tasks to a centrally-managed execution surface,
+streams progress back, and enforces the same guardrails, approvals, and audit logs that
+the Onklave portal applies to every other agent invocation.
+
+---
+
+## Why use it
+
+- **Local feel, cloud governance.** Agents run against your working tree, but every
+  invocation is tracked centrally — start/stop times, model used, persona, approvals,
+  output. No more untracked Claude/Cursor runs hidden in shells.
+- **Policy enforcement before, not after.** Per-project `.onklave.json` declares which
+  tools and paths agents may touch and which commands require human approval. Violations
+  fail the task instead of escaping into a commit.
+- **Multi-machine fleet awareness.** Register every machine that runs agents (laptop,
+  CI runner, server). The portal shows what's active where, and who claimed which task.
+- **Same Claude models, same APIs.** This CLI doesn't replace your model provider — it
+  routes through it. Bring your own Anthropic API key or use platform-managed credentials.
+
+---
+
+## Installation
+
+```bash
+npm install -g @onklave/agent-cli
+```
+
+Requires Node.js **>= 18**. Verify the install:
+
+```bash
+onklave --version
+```
+
+---
+
+## Quick start
+
+```bash
+# 1. Authenticate this machine
+onklave login --token <your-cli-token>
+
+# 2. Confirm identity
+onklave whoami
+
+# 3. Run a diagnostic to catch missing tools / wrong Node version / unreachable platform
+onklave doctor
+
+# 4. Initialise a project (writes .onklave.json with sensible defaults)
+cd my-project
+onklave init
+
+# 5. Run an agent task
+onklave run --task "Add unit tests for the auth module"
+```
+
+Get a CLI token by signing in to the Onklave portal → **Settings → API Tokens →
+Generate new token**. Pick an expiry (Never / 30 days / 90 days / 1 year) and a
+descriptive name (e.g. `laptop-cli`). The plaintext is shown **once** — copy it
+immediately; it can't be retrieved later. Revoke any token from the same page.
+
+---
+
+## Commands
+
+| Command                       | Purpose                                                |
+| ----------------------------- | ------------------------------------------------------ |
+| `onklave login`               | Authenticate this machine against the platform         |
+| `onklave logout`              | Remove stored credentials                              |
+| `onklave whoami`              | Show current identity, org, and auth status            |
+| `onklave doctor`              | Run diagnostic checks (Node version, auth, network)    |
+| `onklave init`                | Create `.onklave.json` in the current directory        |
+| `onklave config`              | View or modify configuration (`get`/`set`/effective)   |
+| `onklave register`            | Register this machine as an agent runner               |
+| `onklave run`                 | Start an agent task                                    |
+| `onklave status [session-id]` | Show one session, or list all active sessions          |
+| `onklave logs <session-id>`   | Stream / fetch logs for a session                      |
+| `onklave stop <session-id>`   | Stop a running session                                 |
+| `onklave approve <session-id>`| Approve a pending approval gate                        |
+| `onklave deny <session-id>`   | Deny a pending approval gate                           |
+
+Run any command with `--help` for its full flag list.
+
+---
+
+## `onklave run` — the primary verb
+
+```bash
+onklave run --task "Refactor the order service to extract the payment adapter"
+```
+
+### Common flags
+
+| Flag                       | Default       | Description                                    |
+| -------------------------- | ------------- | ---------------------------------------------- |
+| `--task <text>`            | _(required)_  | One-line task description                      |
+| `--context <path>`         | `.`           | Working directory the agent operates in        |
+| `--persona <name>`         | from config   | Persona profile (e.g. `security-reviewer`)     |
+| `--workflow <name>`        | from config   | Named workflow defined in the portal           |
+| `--model <model>`          | from config   | Override the model (e.g. `claude-opus-4-7`)    |
+| `--timeout <seconds>`      | `120`         | Hard cap on session runtime                    |
+| `--tui`                    | auto on TTY   | Interactive terminal UI                        |
+| `--headless`               | _(off)_       | No interactive UI; ideal for CI                |
+| `--api-endpoint <url>`     | platform URL  | Override platform API endpoint                 |
+| `--dry-run`                | _(off)_       | Print resolved config and exit without running |
+
+### Examples
+
+```bash
+# Interactive run with the default persona/model
+onklave run --task "Investigate the flaky e2e test in checkout.spec.ts"
+
+# Bound persona + a specific model
+onklave run \
+  --task "Audit the JWT verification code path" \
+  --persona security-reviewer \
+  --model claude-opus-4-7
+
+# Non-interactive (CI-friendly)
+onklave run --task "Generate the release notes for v2.4.0" --headless
+
+# Validate config without spending any tokens
+onklave run --task "Refactor auth" --dry-run
+```
+
+While a task is running, the portal shows live status and any approval gates triggered
+by your guardrails. Approve or deny them from the CLI:
+
+```bash
+onklave approve abc123
+onklave deny    abc123
+```
+
+---
+
+## Configuration
+
+Configuration resolves in this order (highest priority first):
+
+1. **Command-line flags** — `--model`, `--persona`, `--timeout`, etc.
+2. **Environment variables** — `ONKLAVE_*`, `ANTHROPIC_API_KEY`.
+3. **Project config** — `.onklave.json` in the current directory.
+4. **Global config** — `~/.config/onklave/config.json`.
+5. **Platform defaults** — set per-org in the portal.
+
+Use `onklave config` to inspect or change values:
+
+```bash
+onklave config                       # show effective configuration with sources
+onklave config get defaultModel
+onklave config set defaultModel claude-sonnet-4-6
+```
+
+### `.onklave.json` (project-scoped)
+
+`onklave init` writes this template. Edit to suit your project:
+
+```json
+{
+  "project": "my-service",
+  "org": "your-onklave-org-id",
+  "defaults": {
+    "persona": "",
+    "workflow": "",
+    "model": "claude-sonnet-4-20250514",
+    "timeout": 120
+  },
+  "guardrails": [
+    {
+      "name": "no-secrets-access",
+      "match": "file_*",
+      "action": "deny",
+      "reason": "Prevent access to secret files",
+      "paths": [".env*", "*.pem", "*.key"]
+    },
+    {
+      "name": "approve-destructive-commands",
+      "match": "cmd:rm*",
+      "action": "require_approval",
+      "reason": "Destructive commands require approval"
+    }
+  ],
+  "permissions": {
+    "tools_allowed": [],
+    "tools_denied": [],
+    "paths_readable": ["."],
+    "paths_writable": ["src/", "tests/", "docs/"]
+  },
+  "context": {
+    "includes": ["src/", "package.json", "tsconfig.json"],
+    "system_prompt_append": ""
+  }
+}
+```
+
+- **`guardrails`** are evaluated for every tool the agent attempts. Actions: `deny`,
+  `require_approval`, `allow`.
+- **`permissions.paths_writable`** is enforced **before** the agent edit reaches your
+  filesystem — anything outside this list fails fast.
+- **`context.system_prompt_append`** lets you append project conventions to every run
+  without retyping them.
+
+---
+
+## Authentication
+
+```bash
+onklave login --token <your-cli-token> [--platform-url <url>]
+```
+
+Tokens are stored at `~/.config/onklave/credentials.json` (mode `0600`). Remove with
+`onklave logout`.
+
+To register the machine itself (so it shows up in **Settings → Machines** as an agent
+runner that can claim work):
+
+```bash
+onklave register --token <linking-token>
+```
+
+The linking token is generated in the portal under **Settings → Machines → Register
+Machine**.
+
+---
+
+## Revoking access
+
+Tokens can be revoked instantly from the portal — **Settings → API Tokens** → ⋯ → Revoke.
+Revocation takes effect within ~5 minutes (cached resolves expire on that interval).
+
+If you suspect a token has been leaked, revoke it immediately. Existing CLI sessions
+that have already authenticated continue to work *for the user* but lose access on
+their next API call.
+
+---
+
+## Diagnostics
+
+If something looks off:
+
+```bash
+onklave doctor
+```
+
+Checks node version, auth state, platform reachability, working-directory permissions,
+and the local config files. Each failure prints an actionable fix line.
+
+---
+
+## CI usage
+
+```yaml
+# Example GitHub Actions step
+- name: Run release notes agent
+  run: |
+    npm install -g @onklave/agent-cli
+    onklave login --token "${{ secrets.ONKLAVE_CLI_TOKEN }}"
+    onklave run \
+      --task "Draft release notes for ${{ github.ref_name }}" \
+      --headless \
+      --timeout 600
+```
+
+Use `--headless` so there's no TTY-only spinner / interactive UI, and pin the timeout
+to your job budget.
+
+---
+
+## Where things live
+
+| Path                                           | Purpose                                |
+| ---------------------------------------------- | -------------------------------------- |
+| `~/.config/onklave/credentials.json`           | API token, device token, refresh state |
+| `~/.config/onklave/config.json`                | Global per-user config                 |
+| `./.onklave.json`                              | Project-scoped config (commit this)    |
+
+`credentials.json` is created `0600`. Never commit it.
+
+---
+
+## Telemetry
+
+The CLI sends task metadata (id, persona, model, duration, outcome) to your Onklave org
+for the same reasons every other request to the platform does: audit trail, billing,
+fleet visibility. No source code is uploaded unless the agent's tool explicitly reads
+and includes it, and even then it's bound by your `.onklave.json` permissions.
+
+---
+
+## Links
+
+- **Onklave portal:** <https://portal.onklave.app>
+- **Documentation:** <https://docs.onklave.app/cli>
+- **Issues / feedback:** <https://github.com/onklave/onklave-platform/issues>
+
+---
+
+## License
+
+Apache-2.0 — see [LICENSE](./LICENSE).

package/main.js

@@ -189,7 +189,7 @@ async function loginCommand(args) {
     console.log("  2. Navigate to Settings > API Tokens");
     console.log("  3. Generate a new CLI token");
     console.log("  4. Run: onklave login --token <your-token>\n");
-    console.log("Note: Browser-based OAuth login will be available in v2.");
+    console.log("Tokens are bearer credentials. Treat them like passwords.");
     process.exitCode = 1;
     return;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@onklave/agent-cli",
-  "version": "0.1.7",
+  "version": "0.1.9",
   "description": "Onklave Agent CLI — local agent runner with cloud orchestration",
   "bin": {
     "onklave": "./main.js"