@ory/claude-code 0.3.1 → 0.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/README.md +27 -18
  2. package/dist/cli/main.js +22 -21
  3. package/package.json +3 -3
package/README.md CHANGED
@@ -36,11 +36,11 @@ The installer requires the `claude` CLI on `PATH`. After it finishes, run `ory-c
36
36
 
37
37
  </details>
38
38
 
39
- ## Quickstart (≈ 3 minutes)
39
+ ## Quickstart
40
40
 
41
41
  From any project where you'd like Ory authentication, inside Claude Code:
42
42
 
43
- 1. **Start a local Ory instance.** Ask Claude *"start the local Ory stack"* or run the slash command:
43
+ 1. **Start a local Ory instance.** *(~1 min. Requires Docker running.)* Ask Claude *"start the local Ory stack"* or run the slash command:
44
44
 
45
45
  ```
46
46
  /ory-agent-plugin:local-up
@@ -48,10 +48,18 @@ From any project where you'd like Ory authentication, inside Claude Code:
48
48
 
49
49
  A banner prints the seeded test user's email and password. Note them — you'll log in with them in step 3.
50
50
 
51
- 2. **Scaffold Ory into your project.** Ask Claude *"add Ory auth to this app"*. The `ory-auth-setup` skill takes over: it installs Ory Elements, wires the SDK, generates the login / registration / recovery / verification / settings pages, and sets up session middleware. It targets the local stack from step 1, so no signup or API key is needed.
51
+ 2. **Scaffold Ory into your project.** *(~5–10 min, depending on your project.)* Ask Claude *"add Ory auth to this app"*. The `ory-auth-setup` skill takes over: it installs Ory Elements, wires the SDK, generates the login / registration / recovery / verification / settings pages, and sets up session middleware. It targets the local stack from step 1, so no signup or API key is needed.
52
52
 
53
53
  3. **Sign in.** Start your app, visit the login page Claude added, and sign in with the seeded credentials. You now have a real Ory session backed by a real Ory stack — locally, offline, with zero configuration.
54
54
 
55
+ 4. **Turn on Ory login for the Claude session itself.** *(Optional but recommended.)* Out of the box the plugin only governs your *app*. To also attach an Ory identity to *Claude's* session — so every tool call is attributed to you, not a fallback `session:<id>` subject — set:
56
+
57
+ ```bash
58
+ export ORY_AUTH_GATE=1
59
+ ```
60
+
61
+ Then restart Claude. On next session start, Claude opens an Ory login in your browser; sign in with the same seeded credentials from step 1. This is what makes `permissions enforce` (see [Agent security](#agent-security)) deny on the right identity later.
62
+
55
63
  That's the full Ory DX path. Stop here if you're just evaluating the plugin. Continue to [Agent security](#agent-security) when you're ready to enforce.
56
64
 
57
65
  ## What's included
@@ -64,11 +72,11 @@ Each skill is a vetted, end-to-end playbook. Skills are model-invoked — ask Cl
64
72
  - **`ory-login-flow`** *(e.g. "add login and registration pages with Ory Elements")* — login, registration, recovery, verification, and settings pages with Ory Elements. Next.js App Router and React SPA variants.
65
73
  - **`ory-social-login`** *(e.g. "add Google sign-in via Ory")* — Google, GitHub, Apple, Microsoft, Discord, and other OIDC providers with Jsonnet data mappers.
66
74
  - **`ory-local-dev`** *(e.g. "run the local Ory stack")* — drive the local Ory stack from within Claude to prototype and test without a remote project.
67
- - **`ory-permissions-onboarding`** *(e.g. "grant me use on the Bash tool")* — walk through writing the Ory Permissions tuples that let the plugin enforce per-tool access.
75
+ - **`ory-permissions-onboarding`** *(e.g. "grant me use on the Bash tool")* — walk through writing the Ory Permissions that let the plugin enforce per-tool access.
68
76
 
69
77
  ### Ory MCP server
70
78
 
71
- Bundled and registered automatically. Exposes the Ory CLI and the Ory Network REST API as MCP tools so Claude can manage identities, OAuth2 clients, projects, permission tuples, and configuration without ever leaving the chat. Useful for seeding test data, verifying a scaffolded integration, or running one-off admin tasks.
79
+ Bundled and registered automatically. Exposes the Ory CLI and the Ory Network REST API as MCP tools so Claude can manage identities, OAuth2 clients, projects, permissions, and configuration without ever leaving the chat. Useful for seeding test data, verifying a scaffolded integration, or running one-off admin tasks.
72
80
 
73
81
  ### Local Ory stack
74
82
 
@@ -80,37 +88,38 @@ Bundled and registered automatically. Exposes the Ory CLI and the Ory Network RE
80
88
  `local-up` brings up Ory Identities, OAuth2, and Permissions, plus a login UI on `:3000` and Jaeger on `:16686`, all reachable through `http://localhost:4000`. A test user identity is seeded and the credentials are printed for you. Use it to:
81
89
 
82
90
  - **Learn Ory hands-on** without signing up for a hosted project.
83
- - **Prototype** flows (login, social, MFA, recovery, permission tuples) against a real Ory backend.
91
+ - **Prototype** flows (login, social, MFA, recovery, permissions) against a real Ory backend.
84
92
  - **Test** an auth integration end-to-end before pushing anything to a real environment.
85
93
  - **Develop** your application against the same identity, OAuth2, and permission surfaces you'll ship with.
86
94
 
87
95
  ## Pointing at a real Ory project
88
96
 
89
- The Quickstart uses the local stack. If you have a hosted [Ory Network](https://console.ory.sh) project, point the plugin at it:
97
+ The Quickstart uses the local stack. If you have a hosted [Ory Network](https://console.ory.sh) project, point the plugin at it. A project URL is enough — the agent identity is created automatically via OAuth2 Dynamic Client Registration on first run:
90
98
 
91
99
  ```bash
92
100
  npx -y -p @ory/claude-code ory-claude configure \
93
- --project-url https://<id>.projects.oryapis.com \
94
- --api-key ory_pat_...
101
+ --project-url https://<id>.projects.oryapis.com
95
102
  ```
96
103
 
97
- Config is saved to `~/.config/ory-agent-plugins/config.json` and shared across every Ory agent plugin on the machine.
104
+ Pass `--api-key ory_pat_...` only if you want to override the auto-registered agent identity with a static personal access token (operator override; rarely needed).
105
+
106
+ Config is saved to `~/.config/ory-agent-plugins/config.json` and shared across every Ory agent plugin on the machine. The same settings can be supplied via environment variables (`ORY_PROJECT_URL`, `ORY_AGENT_API_KEY`) — env vars take precedence over the config file when both are set, which is what most CI / scripted setups want.
98
107
 
99
- Without configuration the plugin still loads cleanly and runs in **pass-through mode**: skills and commands work, but nothing is blocked. You can stay in pass-through mode indefinitely if you only want the DX features.
108
+ Without any configuration the plugin still loads cleanly and runs in **pass-through mode**: skills, slash commands, and audit logging work, but no permission checks run, so nothing is ever blocked. You can stay in pass-through mode indefinitely if you only want the DX features.
100
109
 
101
110
  ## Agent security
102
111
 
103
112
  Once the plugin is pointed at an Ory project (local or hosted), Claude's session and every tool call can be governed by Ory.
104
113
 
105
114
  - **Authentication.** Two identities. The human at the keyboard (the **user**) authenticates interactively via Ory Identities when `ORY_AUTH_GATE=1` is set. The Claude process (the **agent**) gets its own OAuth2 identity, self-registered via [Dynamic Client Registration (RFC 7591)](https://datatracker.ietf.org/doc/html/rfc7591) on first run. Sub-agents launched by the `Task` tool each receive their own typed identity.
106
- - **Authorization.** Before any tool runs, the plugin checks [Ory Permissions](https://www.ory.sh/docs/keto) (Zanzibar-style relation tuples) against the user's subject and blocks the call on `deny`. MCP tool calls additionally get a server-level check.
107
- - **Audit.** Every decision (allow, deny, fallback) is recorded as a structured trace span: NDJSON file output and/or OTLP/HTTP export to Jaeger, Honeycomb, Grafana, and similar collectors. The user → agent (and agent → subagent) delegation chain is written to Ory as relation tuples so *"agent X acting on behalf of user Y"* stays queryable after tokens expire.
115
+ - **Authorization.** Before any tool runs, the plugin checks [Ory Permissions](https://www.ory.sh/docs/keto) (Zanzibar-style relations) against the user's subject and blocks the call on `deny`. MCP tool calls additionally get a server-level check.
116
+ - **Audit.** Every decision (allow, deny, fallback) is recorded as a structured trace span: NDJSON file output and/or OTLP/HTTP export to Jaeger, Honeycomb, Grafana, and similar collectors. The user → agent (and agent → subagent) delegation chain is written to Ory as relations so *"agent X acting on behalf of user Y"* stays queryable after tokens expire.
108
117
 
109
- The plugin is **fail-open** on its own infrastructure failures (network errors, rate limits, missing config), so enforcement is only as strong as your tuples — grant explicit `invoke` relations for the tools each user should be able to run.
118
+ The plugin is **fail-open** on its own infrastructure failures (network errors, rate limits, missing config), so enforcement is only as strong as your permission grants — grant explicit `use` on the tools each user should be able to run.
110
119
 
111
120
  ### Enable enforcement
112
121
 
113
- After install the plugin runs in **observe mode**: every tool call is checked against Ory Permissions, but a deny is recorded as a `permission.observe_deny` audit span and the tool runs anyway. This lets you see what *would* be blocked before turning on hard blocking.
122
+ With an Ory project configured, the plugin runs in **observe mode** by default: every tool call is checked against Ory Permissions, a deny is recorded as a `permission.observe_deny` audit span, and the tool runs anyway. This lets you see what *would* be blocked before turning on hard blocking. (Without a project configured, the plugin is in pass-through mode — no checks run at all.)
114
123
 
115
124
  1. **Turn on the user gate.** In your shell:
116
125
 
@@ -120,7 +129,7 @@ After install the plugin runs in **observe mode**: every tool call is checked ag
120
129
 
121
130
  The next Claude session opens a browser for PKCE login. Subsequent sessions reuse the persisted token until it expires.
122
131
 
123
- 2. **Bootstrap tuples for the built-in tools.** One idempotent command grants the current user `use` on every tool Claude ships with (Read, Write, Bash, …):
132
+ 2. **Bootstrap permissions for the built-in tools.** One idempotent command grants the current user `use` on every tool Claude ships with (Read, Write, Bash, …):
124
133
 
125
134
  ```bash
126
135
  npx -y -p @ory/claude-code ory-claude permissions bootstrap
@@ -134,7 +143,7 @@ After install the plugin runs in **observe mode**: every tool call is checked ag
134
143
  npx -y -p @ory/claude-code ory-claude permissions status
135
144
  ```
136
145
 
137
- Add tuples for any MCP server tools or custom commands by hand, or via the Ory MCP server from inside Claude (*"grant me use on the Bash tool"*).
146
+ Add permissions for any MCP server tools or custom commands by hand, or via the Ory MCP server from inside Claude (*"grant me use on the Bash tool"*).
138
147
 
139
148
  4. **Promote to enforce.** Once the observe-mode logs look right, switch over:
140
149
 
@@ -158,7 +167,7 @@ npx -y -p @ory/claude-code ory-claude status
158
167
  Highlights:
159
168
 
160
169
  - `agent status` — show the current persisted DCR identity for the agent.
161
- - `permissions observe` / `permissions enforce` — switch between "log denies, allow through" (the install default) and "block denies." `permissions bootstrap` writes `use` tuples for the harness's built-in tools so the promotion path doesn't require hand-writing relationships.
170
+ - `permissions observe` / `permissions enforce` — switch between "log denies, allow through" (the install default) and "block denies." `permissions bootstrap` writes `use` permissions for the harness's built-in tools so the promotion path doesn't require hand-writing relations.
162
171
  - `configure --audit-only` — kill switch that disables Ory entirely (no auth, no permission checks; only audit logging of tool invocations). For phased rollouts, prefer `permissions observe` over `--audit-only`.
163
172
  - `local seed` / `local env` — reseed the test user, or print env vars for pointing other tools at the local stack.
164
173
 
package/dist/cli/main.js CHANGED
@@ -79,7 +79,10 @@ function main() {
79
79
  });
80
80
  break;
81
81
  case "status":
82
- status();
82
+ status().then(() => process.exit(0), (err) => {
83
+ console.error(err.message ?? err);
84
+ process.exit(1);
85
+ });
83
86
  break;
84
87
  case "local":
85
88
  (0, argus_1.runLocalCommand)("ory-claude", args).catch((err) => {
@@ -105,26 +108,24 @@ async function postInstallPermissions(binName, harness) {
105
108
  bootstrappedAutomatically: bootstrapped,
106
109
  });
107
110
  }
108
- function status() {
109
- console.log("Ory Agent Plugin Status (Claude Code)");
110
- console.log("======================================");
111
- console.log("");
112
- (0, argus_1.printOryConfig)();
113
- (0, argus_1.printEnvironment)();
114
- // Plugin-specific status. The default install path delegates plugin
115
- // assembly to the public `ory/claude-plugins` marketplace, so the persistent
116
- // dir below is only populated for `--from-source` installs (the dev launcher
117
- // and local iteration). Run `claude plugin list` for an authoritative view
118
- // of what the `claude` CLI has registered.
119
- console.log("");
120
- console.log("Plugin:");
121
- const assembled = fs.existsSync(PERSISTENT_DIR);
122
- console.log(` Local --from-source dir: ${assembled ? PERSISTENT_DIR : "(none — production installs use the ory/claude-plugins marketplace; run 'claude plugin list' to see registered plugins)"}`);
123
- if (assembled) {
124
- console.log(` Skills: ${fs.existsSync(path.join(PERSISTENT_DIR, "skills")) ? "installed" : "not installed"}`);
125
- }
126
- console.log(` Hook script: ${fs.existsSync(path.join(PACKAGE_ROOT, "dist", "hook.js")) ? "built" : "NOT BUILT (run pnpm build)"}`);
127
- (0, argus_1.printLogTail)();
111
+ async function status() {
112
+ await (0, argus_1.runStatusCommand)("ory-claude", "claude-code", {
113
+ title: "Claude Code",
114
+ printPluginSection: () => {
115
+ // The default install path delegates plugin assembly to the public
116
+ // `ory/claude-plugins` marketplace, so the persistent dir below is
117
+ // only populated for `--from-source` installs (the dev launcher and
118
+ // local iteration). Run `claude plugin list` for an authoritative
119
+ // view of what the `claude` CLI has registered.
120
+ console.log("Hooks & plugin:");
121
+ const assembled = fs.existsSync(PERSISTENT_DIR);
122
+ console.log(` Local --from-source dir: ${assembled ? PERSISTENT_DIR : "(none — production installs use the ory/claude-plugins marketplace; run 'claude plugin list' to see registered plugins)"}`);
123
+ if (assembled) {
124
+ console.log(` Skills: ${fs.existsSync(path.join(PERSISTENT_DIR, "skills")) ? "installed" : "not installed"}`);
125
+ }
126
+ console.log(` Hook script: ${fs.existsSync(path.join(PACKAGE_ROOT, "dist", "hook.js")) ? "built" : "NOT BUILT (run pnpm build)"}`);
127
+ },
128
+ });
128
129
  }
129
130
  function help() {
130
131
  console.log(`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ory/claude-code",
3
- "version": "0.3.1",
3
+ "version": "0.5.0",
4
4
  "description": "Ory plugin for Claude Code: scaffolding skills, a local Ory instance, and authentication, authorization, and audit for every tool call",
5
5
  "license": "Apache-2.0",
6
6
  "homepage": "https://github.com/ory/claude-plugins/tree/master/plugins/ory-agent-plugin",
@@ -75,10 +75,10 @@
75
75
  "!dist/**/*.tsbuildinfo"
76
76
  ],
77
77
  "dependencies": {
78
- "@ory/argus": "0.3.0"
78
+ "@ory/argus": "0.5.0"
79
79
  },
80
80
  "engines": {
81
- "node": ">=24"
81
+ "node": ">=22"
82
82
  },
83
83
  "scripts": {
84
84
  "build": "tsc",