{"repo":"Gitlawb/openclaude","free":true,"listed":false,"github":"https://github.com/Gitlawb/openclaude","clone":"git clone https://github.com/Gitlawb/openclaude.git","description":"runs anywhere. uses anything","language":"TypeScript","stars":30685,"topics":["ai","ai-agent","ai-tools","cli","coding"],"license":null,"category":"ai_agent","readme_excerpt":"
\n \"OpenClaude\n\n

\n \"Gitlawb%2Fopenclaude\n \"Gitlawb%2Fopenclaude\n \"Gitlawb%2Fopenclaude\n

\n
\n\nOpenClaude is an open-source coding-agent CLI for cloud and local model providers.\n\nUse OpenAI-compatible APIs, Gemini, GitHub Models, Codex OAuth, Codex, Ollama, Atomic Chat, and other supported backends while keeping one terminal-first workflow: prompts, tools, agents, MCP, slash commands, and streaming output.\n\n[![PR Checks](https://github.com/Gitlawb/openclaude/actions/workflows/pr-checks.yml/badge.svg?branch=main)](https://github.com/Gitlawb/openclaude/actions/workflows/pr-checks.yml)\n[![Release](https://img.shields.io/github/v/tag/Gitlawb/openclaude?label=release&color=0ea5e9)](https://github.com/Gitlawb/openclaude/tags)\n[![npm downloads](https://img.shields.io/npm/dm/@gitlawb/openclaude)](https://www.npmjs.com/package/@gitlawb/openclaude)\n[![Discussions](https://img.shields.io/badge/discussions-open-7c3aed)](https://github.com/Gitlawb/openclaude/discussions)\n[![Discord](https://img.shields.io/badge/Discord-join-5865F2?logo=discord&logoColor=white)](https://discord.gg/k68zFR6AcB)\n[![X](https://img.shields.io/badge/X-@gitlawb-000000?logo=x&logoColor=white)](https://x.com/gitlawb)\n[![Security Policy](https://img.shields.io/badge/security-policy-0f766e)](SECURITY.md)\n[![License](https://img.shields.io/badge/license-MIT-2563eb)](LICENSE)\n\nOpenClaude is also mirrored to GitLawb:\n[gitlawb.com/node/repos/z6MkqDnb/openclaude](https://gitlawb.com/node/repos/z6MkqDnb/openclaude)\n\n[Quick Start](#quick-start) | [Setup Guides](#setup-guides) | [Providers](#supported-providers) | [Development](#development) | [VS Code Extension](#vs-code-extension) | [Partners](#partners) | [Community](#community)\n\n## Partners\n\n\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n
\n \n \"GitLawb\n \n \n \n \"Bankr.bot\n \n \n \n \"Atomic\n \n \n \n \"Xiaomi\n \n \n \n \"Atlas\n \n
GitLawbBankr.botAtomic ChatXiaomi MiMoAtlas Cloud
\n \n \n \n \"AI/ML\n \n \n \n \n \n \n \"Novita\n \n \n \n \n \n \n \"ApiSmart\n \n \n
AI/ML APINovita AIApiSmart
\n\n## Why OpenClaude\n\n- One CLI across cloud APIs and local model backends — no per-provider tooling\n- Guided provider setup and saved profiles with `/provider`\n- Coding-agent workflows in one place: bash, file tools, grep, glob, agents, tasks, MCP, and web tools\n- A bundled VS Code extension for launch integration and theme support\n- A pixel-art hero companion who fires an arrow every time you press Enter (really — see [Meet your buddy](#meet-your-buddy))\n\n## Quick Start\n\n### Install\n\nOpenClaude requires Node.js `>=22.0.0` for npm installs and runtime. Bun is\nonly needed for source builds and local development.\n\n```bash\nnpm install -g @gitlawb/openclaude@latest\n```\n\nIf you're on Arch Linux, you can install OpenClaude from the community-maintained [AUR package](https://aur.archlinux.org/packages/openclaude):\n```bash\nparu -S openclaude\n```\n\nIf the install later reports `ripgrep not found`, install ripgrep system-wide and confirm `rg --version` works in the same terminal before starting OpenClaude.\n\n**Verify / troubleshoot installed version:**\n\n```bash\nopenclaude --version\nnpm view @gitlawb/openclaude dist-tags\nnpm install -g @gitlawb/openclaude@latest\n```\n\n### Start\n\n```bash\nopenclaude\n```\n\nInside OpenClaude:\n\n- run `/provider` for guided provider setup and saved profiles\n- run `/onboard-github` for GitHub Models onboarding\n\n> **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.\n\n### Resume or fork a conversation\n\nResume an existing conversation by session ID, or continue the most recent\nconversation in the current directory:\n\n```bash\nopenclaude --resume \nopenclaude --continue\n```\n\nAdd `--fork-session` to branch the conversation history into a new session ID\ninstead of reusing the original transcript:\n\n```bash\nopenclaude --resume --fork-session\nopenclaude --continue --fork-session\n```\n\nForking is conversation branching only. It does not create filesystem isolation,\ncopy your working tree, or create a git worktree branch.\n\n### Background sessions\n\nRun long non-interactive prompts detached from the current terminal:\n\n```bash\nopenclaude --bg \"fix failing tests\"\nopenclaude --bg --name auth-refactor \"refactor auth middleware\"\nopenclaude ps\nopenclaude logs auth-refactor\nopenclaude logs auth-refactor -f\nopenclaude kill auth-refactor\n```\n\nBackground sessions are local child processes. OpenClaude does not start a daemon\nor network service, and permission/provider/model/settings flags are passed to\nthe child process the same way they are for a foreground `--print` run. Session\nmetadata and logs are stored under the resolved OpenClaude config directory,\nusually `~/.openclaude/bg-sessions/`; `OPENCLAUDE_CONFIG_DIR` can point\nOpenClaude somewhere else. `CLAUDE_CONFIG_DIR` is ignored for OpenClaude\nbackground-session storage. Session names can be reused after older sessions\nreach a terminal state; use the session ID to inspect older logs with the same\nname. A naturally finished session is recorded as `exited` when its process\nreturns zero and `failed` when it returns nonzero or handles a termination\nsignal. `stale` remains the conservative result when the process disappears\nwithout an observed outcome; an explicit successful `openclaude kill` is\nrecorded as `killed`, and `killed` takes precedence over a natural `exited` or\n`failed` outcome for the same process. Terminal outcomes are stored separately\nunder `bg-sessions/terminal/`; deleting that directory makes finished sessions\nfall back to liveness-derived status. OpenClaude does not infer POSIX signal\nnames on Windows.\nUnobservable force termination, host crashes, and power loss remain `stale` on\nevery platform.\n\n`openclaude attach ` currently reports the matching session and\npoints to `openclaude logs -f`; full terminal reattach is not implemented\nfor local background sessions yet.\n\n### OpenClaude config cutover\n\nOpenClaude stores its own config under `~/.openclaude` and `~/.openclaude.json`\nby default. It does not read `~/.claude`, project `.claude/` directories, or\n`CLAUDE_CONFIG_DIR`; new users can start with an em","default_branch":"main","files":3401,"tree":[".bun-version",".coderabbit.yaml",".dockerignore",".env.example",".gitattributes",".github/ISSUE_TEMPLATE/bug_report.md",".github/ISSUE_TEMPLATE/config.yml",".github/ISSUE_TEMPLATE/feature_request.md",".github/pull_request_template.md",".github/workflows/install-hygiene.yml",".github/workflows/pr-checks.yml",".github/workflows/release.yml",".gitignore",".node-version",".npmignore",".nvmrc",".release-please-manifest.json","AGENTS.md","ANDROID_INSTALL.md","CHANGELOG.md","CODE_OF_CONDUCT.md","CONTRIBUTING.md","Dockerfile","LICENSE","PLAYBOOK.md","README.md","SECURITY.md","bin/import-specifier.mjs","bin/import-specifier.test.mjs","bin/node-compile-cache.mjs","bin/openclaude","bun.lock","docs/advanced-setup.md","docs/agent-routing.md","docs/aimlapi-setup.md","docs/architecture/integrations.md","docs/assets/aimlapi-logo-dark.svg","docs/assets/aimlapi-logo.svg","docs/assets/apismart-logo-dark.png","docs/assets/apismart-logo.png","docs/assets/atlas-cloud-banner.png","docs/assets/atomic-chat-logo.png","docs/assets/novita-logo-dark.svg","docs/assets/novita-logo.svg","docs/assets/openclaude-wordmark.png","docs/assets/openclaude-wordmark.svg","docs/grpc-server.md","docs/hook-chains.md","docs/integrations/common-pitfalls.md","docs/integrations/glossary.md","docs/integrations/how-to/add-anthropic-proxy.md","docs/integrations/how-to/add-gateway.md","docs/integrations/how-to/add-model.md","docs/integrations/how-to/add-usage-support.md","docs/integrations/how-to/add-vendor.md","docs/integrations/overview.md","docs/integrations/reasoning-effort.md","docs/integrations/reference-samples.md","docs/litellm-setup.md","docs/non-technical-setup.md","docs/quick-start-mac-linux.md","docs/quick-start-windows.md","docs/repo-map.md","docs/smart-routing.md","docs/windows-aliases-and-launchers.md","knip.json","package.json","release-please-config.json","scripts/benchmark-openclaude-startup.mjs","scripts/build.ts","scripts/externals.ts","scripts/externalsValidation.test.ts","scripts/externalsValidation.ts","scripts/feature-flags-source-guard.test.ts","scripts/fixtures/instrument-node-compile-cache.mjs","scripts/generate-integrations-artifacts.ts","scripts/generate-sdk-types.ts","scripts/grpc-cli.ts","scripts/missing-module-stub.test.ts","scripts/no-ant-employee-gates.test.ts","scripts/no-raw-abort-signal-timeout.test.ts","scripts/no-telemetry-growthbook-stub.test.ts","scripts/no-telemetry-plugin.ts","scripts/openclaude-bin-compile-cache.test.ts","scripts/openclaude-bin-heap.test.ts","scripts/optionalRuntimeSpecifiers.test.ts","scripts/pr-intent-scan.test.ts","scripts/pr-intent-scan.ts","scripts/provider-bootstrap.ts","scripts/provider-discovery.ts","scripts/provider-launch.test.ts","scripts/provider-launch.ts","scripts/provider-recommend.test.ts","scripts/provider-recommend.ts","scripts/reactJsxDevRuntimeProductionShim.js","scripts/reactJsxDevRuntimeProductionShim.test.ts","scripts/render-coverage-heatmap.ts","scripts/start-grpc.ts","scripts/stubMarkerGuard.test.ts","scripts/stubMarkerGuard.ts","scripts/system-check.test.ts","scripts/system-check.ts","scripts/typecheck-type-tests.ts","scripts/validate-externals.ts","scripts/verify-clean-install.test.ts","scripts/verify-clean-install.ts","scripts/verify-no-phone-home.sh","scripts/verify-no-phone-home.ts","scripts/windows/openclaude-aliases.ps1","src/QueryEngine.autoCompactCooldown.test.ts","src/QueryEngine.customPricingBudget.test.ts","src/QueryEngine.interruptionTrace.test.ts","src/QueryEngine.ts","src/Task.ts","src/Tool.ts","src/__tests__/bugfixes.test.ts","src/__tests__/doctorContextWarnings.test.ts","src/__tests__/process-title.test.ts","src/__tests__/providerCounts.test.ts","src/__tests__/security-hardening.test.ts","src/__tests__/statusNoticeLocalModel.test.ts","src/assistant/AssistantSessionChooser.tsx","src/assistant/gate.ts","src/assistant/index.ts","src/assistant/sessionDiscovery.ts","src/assistant/sessionHistory.test.ts","src/assistant/sessionHistory.ts","src/assistant/sessionHistorySerialization.ts","src/bootstrap/state.modelUsageProto.test.ts","src/bootstrap/state.ts","src/bridge/bridgeApi.ts","src/bridge/bridgeConfig.ts","src/bridge/bridgeDebug.ts","src/bridge/bridgeEnabled.ts","src/bridge/bridgeMain.ts","src/bridge/bridgeMessaging.ts","src/bridge/bridgePermissionCallbacks.ts","src/bridge/bridgePointer.ts","src/bridge/bridgeStatusUtil.ts","src/bridge/bridgeUI.ts","src/bridge/capacityWake.ts","src/bridge/codeSessionApi.ts","src/bridge/createSession.ts","src/bridge/debugUtils.ts","src/bridge/envLessBridgeConfig.ts","src/bridge/flushGate.ts","src/bridge/inboundAttachments.ts","src/bridge/inboundMessages.ts","src/bridge/initReplBridge.titleTruncation.test.ts","src/bridge/initReplBridge.ts","src/bridge/jwtUtils.ts","src/bridge/peerSessions.ts","src/bridge/pollConfig.ts","src/bridge/pollConfigDefaults.ts","src/bridge/remoteBridgeCore.ts","src/bridge/replBridge.ts","src/bridge/replBridgeHandle.ts","src/bridge/replBridgeTransport.ts","src/bridge/replBridgeTransport.types.test.ts","src/bridge/sessionIdCompat.ts","src/bridge/sessionRunner.test.ts","src/bridge/sessionRunner.ts","src/bridge/trustedDevice.ts","src/bridge/types.ts","src/bridge/webhookSanitizer.ts","src/bridge/workSecret.test.ts","src/bridge/workSecret.ts","src/buddy/CompanionActionFX.test.tsx","src/buddy/CompanionActionFX.tsx","src/buddy/CompanionSprite.test.tsx","src/buddy/CompanionSprite.tsx","src/buddy/actionEffects.test.ts","src/buddy/actionEffects.ts","src/buddy/companion.test.ts","src/buddy/companion.ts","src/buddy/deterministic.ts","src/buddy/feature.ts","src/buddy/observer.ts","src/buddy/pixelSprites.test.ts","src/buddy/pixelSprites.ts","src/buddy/prompt.ts","src/buddy/sprites.test.ts","src/buddy/sprites.ts","src/buddy/types.test.ts","src/buddy/types.ts","src/buddy/useBuddyNotification.tsx","src/buddy/useShotClock.ts","src/cli/aimlapiCommand.test.ts","src/cli/aimlapiCommand.ts","src/cli/bg.test.ts","src/cli/bg.ts","src/cli/bgFinalizer.fixture.ts","src/cli/bgFinalizer.test.ts","src/cli/bgFinalizer.ts","src/cli/bgRegistry.test.ts","src/cli/bgRegistry.ts","src/cli/bgRouting.ts","src/cli/commands/taskReport.ts","src/cli/exit.ts","src/cli/handlers/agents.ts","src/cli/handlers/aimlapi.test.ts","src/cli/handlers/aimlapi.ts","src/cli/handlers/auth.ts","src/cli/handlers/autoMode.ts","src/cli/handlers/doctorReport.ts","src/cli/handlers/mcp.tsx","src/cli/handlers/plugins.ts","src/cli/handlers/skills.test.ts","src/cli/handlers/skills.ts","src/cli/handlers/skillsCli.ts","src/cli/handlers/skillsInstall.ts","src/cli/handlers/skillsListFormat.ts","src/cli/handlers/skillsRemoveMessage.ts","src/cli/handlers/skillsValidation.ts","src/cli/handlers/taskReport.ts","src/cli/handlers/templateJobs.ts","src/cli/handlers/util.tsx","src/cli/handlers/xaiAuth.test.ts","src/cli/handlers/xaiAuth.ts","src/cli/headlessHeartbeat.test.ts","src/cli/headlessHeartbeat.ts","src/cli/ndjsonSafeStringify.ts","src/cli/print.interruptionTrace.test.ts","src/cli/print.sdkModelOptions.test.ts","src/cli/print.ts","src/cli/printHeartbeat.test.ts","src/cli/printInterruption.ts","src/cli/printMaxTurns.test.ts","src/cli/remoteIO.ts","src/cli/structuredIO.ts","src/cli/transports/HybridTransport.test.ts","src/cli/transports/HybridTransport.ts","src/cli/transports/SSETransport.ts","src/cli/transports/SerialBatchEventUploader.ts","src/cli/transports/Transport.ts","src/cli/transports/WebSocketTransport.ts","src/cli/transports/WorkerStateUploader.ts","src/cli/transports/ccrClient.test.ts","src/cli/transports/ccrClient.ts","src/cli/transports/transportUtils.ts","src/cli/update.test.ts","src/cli/update.ts","src/commands.test.ts","src/commands.ts","src/commands/add-dir/add-dir.tsx","src/commands/add-dir/index.ts","src/commands/add-dir/validation.ts","src/commands/ads.test.ts","src/commands/ads.tsx","src/commands/advisor.ts","src/commands/agents-platform/index.ts","src/commands/agents/agents.tsx","src/commands/agents/index.ts","src/commands/ant-trace/index.js","src/commands/assistant/AssistantSessionChooser.ts","src/commands/assistant/assistant.ts","src/commands/auto-fix.test.ts","src/commands/auto-fix.ts","src/commands/autofix-pr/index.js","src/commands/backfill-sessions/index.js","src/commands/branch/branch.test.ts","src/commands/branch/branch.ts","src/commands/branch/index.ts","src/commands/break-cache/index.js","src/commands/bridge-kick.ts","src/commands/bridge/bridge.tsx","src/commands/bridge/index.ts","src/commands/brief.ts","src/commands/btw/btw.tsx","src/commands/btw/index.ts","src/commands/buddy/buddy.tsx","src/commands/buddy/index.ts","src/commands/bughunter-perf/index.ts","src/commands/bughunter-security/index.ts","src/commands/bughunter/index.ts","src/commands/cache-probe/cache-probe.test.ts","src/commands/cache-probe/cache-probe.ts","src/commands/cache-probe/index.ts","src/commands/cacheStats/cacheStats.test.ts","src/commands/cacheStats/cacheStats.ts","src/commands/cacheStats/index.ts","src/commands/chrome/chrome.tsx","src/commands/chrome/index.ts","src/commands/clear-context-window/clear-context-window.ts","src/commands/clear-context-window/index.ts","src/commands/clear/caches.ts","src/commands/clear/clear.ts","src/commands/clear/conversation.goal.test.ts","src/commands/clear/conversation.ts","src/commands/clear/index.ts","src/commands/color/color.ts","src/commands/color/index.ts","src/commands/commit-message/commit-message.test.ts","src/commands/commit-message/commit-message.ts","src/commands/commit-message/index.ts","src/commands/commit-push-pr.ts","src/commands/commit.ts","src/commands/compact/compact.ts","src/commands/compact/index.ts","src/commands/config/config.tsx","src/commands/config/index.ts","src/commands/context/context-noninteractive.ts","src/commands/context/context.tsx","src/commands/context/index.ts","src/commands/copy/copy.tsx","src/commands/copy/index.ts","src/commands/cost/cost.ts","src/commands/cost/index.ts","src/commands/createMovedToPluginCommand.ts","src/commands/ctx_viz/ctx-noninteractive.ts","src/commands/ctx_viz/ctx_viz.test.ts","src/commands/ctx_viz/index.ts","src/commands/debug-tool-call/index.js","src/commands/desktop/desktop.tsx","src/commands/desktop/index.ts","src/commands/diagnostics/diagnostics.test.ts","src/commands/diagnostics/diagnostics.ts","src/commands/diagnostics/index.test.ts","src/commands/diagnostics/index.ts","src/commands/diff/diff.tsx","src/commands/diff/index.ts","src/commands/doctor/doctor.test.tsx","src/commands/doctor/doctor.tsx","src/commands/doctor/index.ts","src/commands/dream/dream.ts","src/commands/dream/index.ts","src/commands/effort/effort.test.tsx","src/commands/effort/effort.tsx","src/commands/effort/index.ts","src/commands/env/index.js","src/commands/exit/exit.tsx","src/commands/exit/index.ts","src/commands/export/export.test.ts","src/commands/export/export.tsx","src/commands/export/index.ts","src/commands/extra-usage/extra-usage-core.ts","src/commands/extra-usage/extra-usage-noninteractive.ts","src/commands/extra-usage/extra-usage.tsx","src/commands/extra-usage/index.ts","src/commands/fast/fast.customPricing.test.ts","src/commands/fast/fast.tsx","src/commands/fast/index.ts","src/commands/feedback/feedback.tsx","src/commands/feedback/index.ts","src/commands/files/files.ts","src/commands/files/index.ts","src/commands/goal/goal.test.ts","src/commands/goal/goal.ts","src/commands/goal/index.ts","src/commands/good-claude/index.js","src/commands/heapdump/heapdump.ts","src/commands/heapdump/index.ts","src/commands/help/help.tsx","src/commands/help/index.ts","src/commands/hooks/hooks.tsx","src/commands/hooks/index.ts","src/commands/ide/ide.tsx","src/commands/ide/index.ts","src/commands/init-verifiers.ts","src/commands/init.test.ts","src/commands/init.ts","src/commands/initMode.ts","src/commands/insights.ts","src/commands/install-github-app/ApiKeyStep.tsx","src/commands/install-github-app/CheckExistingSecretStep.tsx","src/commands/install-github-app/CheckGitHubStep.tsx","src/commands/install-github-app/ChooseRepoStep.tsx","src/commands/install-github-app/CreatingStep.tsx","src/commands/install-github-app/ErrorStep.tsx","src/commands/install-github-app/ExistingWorkflowStep.tsx","src/commands/install-github-app/InstallAppStep.tsx","src/commands/install-github-app/OAuthFlowStep.tsx","src/commands/install-github-app/SuccessStep.tsx","src/commands/install-github-app/WarningsStep.tsx","src/commands/install-github-app/index.ts","src/commands/install-github-app/install-github-app.tsx","src/commands/install-github-app/repoSlug.test.ts","src/commands/install-github-app/repoSlug.ts","src/commands/install-github-app/setupGitHubActions.test.ts","src/commands/install-github-app/setupGitHubActions.ts","src/commands/install-github-app/types.ts","src/commands/install-slack-app/index.ts","src/commands/install-slack-app/install-slack-app.ts","src/commands/install.tsx","src/commands/issue/index.js","src/commands/keybindings/index.ts","src/commands/keybindings/keybindings.ts","src/commands/knowledge/index.ts","src/commands/knowledge/knowledge.test.ts","src/commands/knowledge/knowledge.ts","src/commands/login/index.ts","src/commands/login/login.tsx","src/commands/logo/index.ts","src/commands/logo/logo.tsx","src/commands/logout/index.ts","src/commands/logout/logout.tsx","src/commands/lsp/index.ts","src/commands/lsp/lsp.test.ts","src/commands/lsp/lsp.ts","src/commands/mcp/addCommand.ts"],"storefront":"/r/Gitlawb","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/Gitlawb/openclaude/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}