@makerbi/openclaude 0.20.1 → 0.21.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.
- package/README.md +43 -1
- package/bin/openclaude +1 -1
- package/dist/cli.mjs +317 -283
- package/dist/sdk.mjs +2374 -820
- package/package.json +1 -1
- package/src/entrypoints/sdk/coreTypes.generated.ts +1 -0
- package/src/entrypoints/sdk.d.ts +22 -1
package/README.md
CHANGED
|
@@ -100,6 +100,27 @@ Inside OpenClaude:
|
|
|
100
100
|
|
|
101
101
|
> **Note:** OpenClaude does not automatically load project `.env` files. We recommend using the `/provider` command for setup, which saves provider profiles and credentials in `.openclaude-profile.json`. If you prefer environment variables, export them explicitly or run `openclaude --provider-env-file .env` for provider/setup variables. Export runtime/debug knobs from your shell or launcher.
|
|
102
102
|
|
|
103
|
+
### Resume or fork a conversation
|
|
104
|
+
|
|
105
|
+
Resume an existing conversation by session ID, or continue the most recent
|
|
106
|
+
conversation in the current directory:
|
|
107
|
+
|
|
108
|
+
```bash
|
|
109
|
+
openclaude --resume <session-id>
|
|
110
|
+
openclaude --continue
|
|
111
|
+
```
|
|
112
|
+
|
|
113
|
+
Add `--fork-session` to branch the conversation history into a new session ID
|
|
114
|
+
instead of reusing the original transcript:
|
|
115
|
+
|
|
116
|
+
```bash
|
|
117
|
+
openclaude --resume <session-id> --fork-session
|
|
118
|
+
openclaude --continue --fork-session
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
Forking is conversation branching only. It does not create filesystem isolation,
|
|
122
|
+
copy your working tree, or create a git worktree branch.
|
|
123
|
+
|
|
103
124
|
### Background sessions
|
|
104
125
|
|
|
105
126
|
Run long non-interactive prompts detached from the current terminal:
|
|
@@ -170,6 +191,13 @@ $env:OPENAI_MODEL="qwen2.5-coder:7b"
|
|
|
170
191
|
openclaude
|
|
171
192
|
```
|
|
172
193
|
|
|
194
|
+
For Ollama, OpenClaude uses Ollama's native chat API and requests a 32768-token
|
|
195
|
+
context window on each chat request so same-session history is not silently
|
|
196
|
+
truncated by Ollama's OpenAI-compatible shim. Set `OPENCLAUDE_OLLAMA_NUM_CTX`
|
|
197
|
+
or `OLLAMA_CONTEXT_LENGTH` if you need a different request-level context size.
|
|
198
|
+
See [Advanced Setup](docs/advanced-setup.md#ollama-context-length) for
|
|
199
|
+
verification with `ollama ps`.
|
|
200
|
+
|
|
173
201
|
## Setup Guides
|
|
174
202
|
|
|
175
203
|
Beginner-friendly guides:
|
|
@@ -191,6 +219,7 @@ Advanced and source-build guides:
|
|
|
191
219
|
| Z.AI GLM Coding Plan | `/provider` or OpenAI-compatible env vars | Uses `OPENAI_API_KEY` at `https://api.z.ai/api/coding/paas/v4` and defaults to `glm-5.2` |
|
|
192
220
|
| Hicap | `/provider` or OpenAI-compatible env vars | Uses `api-key` auth, discovers models from unauthenticated `/models`, and supports Responses mode for `gpt-` models |
|
|
193
221
|
| Fireworks AI | `/provider` or env vars | First-class provider with 276 curated models (DeepSeek, Qwen, Llama, Gemma, and more); uses `FIREWORKS_API_KEY` |
|
|
222
|
+
| ClinePass | `/provider` or env vars | AI model gateway with usage limits (5hr, weekly, monthly); uses `CLINE_API_KEY` at `https://api.cline.bot/api/v1` |
|
|
194
223
|
| Gemini | `/provider` or env vars | Supports API key only |
|
|
195
224
|
| GitHub Models | `/onboard-github` | Interactive onboarding with saved credentials |
|
|
196
225
|
| Codex OAuth | `/provider` | Opens ChatGPT sign-in in your browser and stores Codex credentials securely |
|
|
@@ -242,6 +271,20 @@ The `is_async` field reported in the `tengu_agent_tool_selected` event and the a
|
|
|
242
271
|
|
|
243
272
|
For best results, use models with strong tool/function calling support.
|
|
244
273
|
|
|
274
|
+
### Agent step limits
|
|
275
|
+
|
|
276
|
+
Custom agents can define `maxSteps` as a positive integer to cap how many tool-use steps a sub-agent may execute. When the limit is reached, OpenClaude stops additional tool calls and asks the sub-agent for a concise final summary covering completed work, findings, remaining tasks, and whether another run is needed. Omitting `maxSteps`, or setting it to an invalid value such as `0` or malformed input, preserves the default unlimited behavior.
|
|
277
|
+
|
|
278
|
+
```markdown
|
|
279
|
+
---
|
|
280
|
+
name: bounded-researcher
|
|
281
|
+
description: Use for focused research with bounded tool use
|
|
282
|
+
maxSteps: 8
|
|
283
|
+
---
|
|
284
|
+
|
|
285
|
+
You are a focused research agent.
|
|
286
|
+
```
|
|
287
|
+
|
|
245
288
|
## Agent Routing
|
|
246
289
|
|
|
247
290
|
OpenClaude can route different agents to different models through settings-based routing. This is useful for cost optimization or splitting work by model strength.
|
|
@@ -424,7 +467,6 @@ Coverage output is written to `coverage/lcov.info`, and OpenClaude also generate
|
|
|
424
467
|
- `src/` - core CLI/runtime
|
|
425
468
|
- `scripts/` - build, verification, and maintenance scripts
|
|
426
469
|
- `docs/` - setup, contributor, and project documentation
|
|
427
|
-
- `python/` - standalone Python helpers and their tests
|
|
428
470
|
- `vscode-extension/openclaude-vscode/` - VS Code extension
|
|
429
471
|
- `.github/` - repo automation, templates, and CI configuration
|
|
430
472
|
- `bin/` - CLI launcher entrypoints
|
package/bin/openclaude
CHANGED
|
@@ -78,7 +78,7 @@ function relaunchWithLongSessionHeapIfNeeded() {
|
|
|
78
78
|
// Preserve the original argv[1] (which may be a symlink like
|
|
79
79
|
// /usr/local/bin/openclaude) instead of resolving it via import.meta.url.
|
|
80
80
|
// Resolving symlinks here defeats install-type detection downstream: a real
|
|
81
|
-
// npm global install (symlink
|
|
81
|
+
// npm global install (symlink -> node_modules/@makerbi/openclaude/bin) would
|
|
82
82
|
// resolve to the package's real path inside node_modules, which is fine, but
|
|
83
83
|
// a `npm install -g .` dev symlink resolves back to the repo and looks like
|
|
84
84
|
// a source-tree dev run. Using argv[1] keeps the invocation path stable so
|