codebuff-cli 1.0.16 → 1.0.18

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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 2025 Manicode, Inc.
+
+   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,107 +1,251 @@
-# The most powerful coding agent
+# Codebuff & Freebuff
 
-Codebuff is a CLI tool that writes code for you.
+English | [简体中文](./README.zh-CN.md)
 
-1. Run `codebuff` from your project directory
-2. Tell it what to do
-3. It will read and write to files and run commands to produce the code you want
+**[Codebuff](https://codebuff.com)** is an open-source AI coding assistant that edits your codebase through natural language instructions. **[Freebuff](https://www.npmjs.com/package/freebuff)** is the free, ad-supported version — no subscription, no credits, no configuration.
 
-Note: Codebuff will run commands in your terminal as it deems necessary to fulfill your request.
+Instead of using one model for everything, Codebuff coordinates specialized agents that work together to understand your project and make precise changes.
 
-## Installation
+<div align="center">
+  <img src="./assets/codebuff-vs-claude-code.png" alt="Codebuff vs Claude Code" width="400">
+</div>
 
-To install Codebuff, run:
+Codebuff beats Claude Code at 61% vs 53% on [our evals](evals/README.md) across 175+ coding tasks over multiple open-source repos that simulate real-world tasks.
+
+
+## How it works
+
+When you ask Codebuff to "add authentication to my API," it might invoke:
+
+1. A **File Picker Agent** to scan your codebase to understand the architecture and find relevant files
+2. A **Planner Agent** to plan which files need changes and in what order
+3. An **Editor Agent** to make precise edits
+4. A **Reviewer Agent** to validate changes
+
+<div align="center">
+  <img src="./assets/multi-agents.png" alt="Codebuff Multi-Agents" width="250">
+</div>
+
+This multi-agent approach gives you better context understanding, more accurate edits, and fewer errors compared to single-model tools.
+
+## CLI: Install and start coding
+
+Install:
 
 ```bash
 npm install -g codebuff
 ```
 
-(Use `sudo` if you get a permission error.)
+Run:
+
+```bash
+cd your-project
+codebuff
+```
+
+Then just tell Codebuff what you want and it handles the rest:
+
+- "Fix the SQL injection vulnerability in user registration"
+- "Add rate limiting to all API endpoints"
+- "Refactor the database connection code for better performance"
+
+Codebuff will find the right files, makes changes across your codebase, and runs tests to make sure nothing breaks.
 
-## Usage
+## Create custom agents
 
-After installation, you can start Codebuff by running:
+To get started building your own agents, start Codebuff and run the `/init` command:
 
 ```bash
-codebuff [project-directory]
+codebuff
 ```
 
-If no project directory is specified, Codebuff will use the current directory.
-
-Once running, simply chat with Codebuff to say what coding task you want done.
+Then inside the CLI:
 
-## Features
+```
+/init
+```
 
-- Understands your whole codebase
-- Creates and edits multiple files based on your request
-- Can run your tests or type checker or linter; can install packages
-- It's powerful: ask Codebuff to keep working until it reaches a condition and it will.
+This creates:
+```
+knowledge.md               # Project context for Codebuff
+.agents/
+└── types/                 # TypeScript type definitions
+    ├── agent-definition.ts
+    ├── tools.ts
+    └── util-types.ts
+```
 
-Our users regularly use Codebuff to implement new features, write unit tests, refactor code,write scripts, or give advice.
+You can write agent definition files that give you maximum control over agent behavior.
 
-## Knowledge Files
+Implement your workflows by specifying tools, which agents can be spawned, and prompts. We even have TypeScript generators for more programmatic control.
 
-To unlock the full benefits of modern LLMs, we recommend storing knowledge alongside your code. Add a `knowledge.md` file anywhere in your project to provide helpful context, guidance, and tips for the LLM as it performs tasks for you.
+For example, here's a `git-committer` agent that creates git commits based on the current git state. Notice that it runs `git diff` and `git log` to analyze changes, but then hands control over to the LLM to craft a meaningful commit message and perform the actual commit.
 
-Codebuff can fluently read and write files, so it will add knowledge as it goes. You don't need to write knowledge manually!
+```typescript
+export default {
+  id: 'git-committer',
+  displayName: 'Git Committer',
+  model: 'openai/gpt-5-nano',
+  toolNames: ['read_files', 'run_terminal_command', 'end_turn'],
 
-Some have said every change should be paired with a unit test. In 2024, every change should come with a knowledge update!
+  instructionsPrompt:
+    'You create meaningful git commits by analyzing changes, reading relevant files for context, and crafting clear commit messages that explain the "why" behind changes.',
 
-## Tips
+  async *handleSteps() {
+    // Analyze what changed
+    yield { tool: 'run_terminal_command', command: 'git diff' }
+    yield { tool: 'run_terminal_command', command: 'git log --oneline -5' }
 
-1. Type '/help' or just '/' to see available commands.
-2. Create a `knowledge.md` file and collect specific points of advice. The assistant will use this knowledge to improve its responses.
-3. Type `undo` or `redo` to revert or reapply file changes from the conversation.
-4. Press `Esc` or `Ctrl+C` while Codebuff is generating a response to stop it.
+    // Stage files and create commit with good message
+    yield 'STEP_ALL'
+  },
+}
+```
 
-## Troubleshooting
+## SDK: Run agents in production
 
-### Permission Errors
+Install the [SDK package](https://www.npmjs.com/package/@codebuff/sdk) -- note this is different than the CLI codebuff package.
 
-If you are getting permission errors during installation, try using sudo:
+```bash
+npm install @codebuff/sdk
+```
 
+Import the client and run agents!
+
+```typescript
+import { CodebuffClient } from '@codebuff/sdk'
+
+// 1. Initialize the client
+const client = new CodebuffClient({
+  apiKey: 'your-api-key',
+  cwd: '/path/to/your/project',
+  onError: (error) => console.error('Codebuff error:', error.message),
+})
+
+// 2. Do a coding task...
+const result = await client.run({
+  agent: 'base', // Codebuff's base coding agent
+  prompt: 'Add error handling to all API endpoints',
+  handleEvent: (event) => {
+    console.log('Progress', event)
+  },
+})
+
+// 3. Or, run a custom agent!
+const myCustomAgent: AgentDefinition = {
+  id: 'greeter',
+  displayName: 'Greeter',
+  model: 'openai/gpt-5.1',
+  instructionsPrompt: 'Say hello!',
+}
+await client.run({
+  agent: 'greeter',
+  agentDefinitions: [myCustomAgent],
+  prompt: 'My name is Bob.',
+  customToolDefinitions: [], // Add custom tools too!
+  handleEvent: (event) => {
+    console.log('Progress', event)
+  },
+})
 ```
-sudo npm install -g codebuff
+
+Learn more about the SDK [here](https://www.npmjs.com/package/@codebuff/sdk).
+
+## Freebuff: The free coding agent
+
+Don't want a subscription? **[Freebuff](https://www.npmjs.com/package/freebuff)** is a free variant of Codebuff — no subscription, no credits, no configuration. Just install and start coding.
+
+```bash
+npm install -g freebuff
+cd your-project
+freebuff
 ```
 
-If you still have errors, it's a good idea to [reinstall Node](https://nodejs.org/en/download).
+Freebuff is ad-supported and uses models optimized for fast, high-quality assistance. It includes built-in web research, browser use, and more. Learn more in the [Freebuff README](./freebuff/README.md).
 
-### Corporate Proxy / Firewall
+## Why choose Codebuff
 
-If you see `Failed to download codebuff: Request timeout` or `Failed to determine latest version`, you may be behind a corporate proxy or firewall.
+**Custom workflows**: TypeScript generators let you mix AI generation with programmatic control. Agents can spawn subagents, branch on conditions, and run multi-step processes.
 
-Codebuff respects standard proxy environment variables. Set `HTTPS_PROXY` to route traffic through your proxy:
+**Any model on OpenRouter**: Unlike Claude Code which locks you into Anthropic's models, Codebuff supports any model available on [OpenRouter](https://openrouter.ai/models) - from Claude and GPT to specialized models like Qwen, DeepSeek, and others. Switch models for different tasks or use the latest releases without waiting for platform updates.
+
+**Reuse any published agent**: Compose existing [published agents](https://www.codebuff.com/store) to get a leg up. Codebuff agents are the new MCP!
+
+**SDK**: Build Codebuff into your applications. Create custom tools, integrate with CI/CD, or embed coding assistance into your products.
+
+## Advanced Usage
+
+### Custom Agent Workflows
+
+Create your own agents with specialized workflows using the `/init` command:
 
-**Linux / macOS (bash/zsh):**
 ```bash
-export HTTPS_PROXY=http://your-proxy-server:port
 codebuff
+/init
 ```
 
-**Windows (PowerShell):**
-```powershell
-$env:HTTPS_PROXY = "http://your-proxy-server:port"
-codebuff
+This creates a custom agent structure in `.agents/` that you can customize.
+
+## Contributing to Codebuff
+
+We ❤️ contributions from the community - whether you're fixing bugs, tweaking our agents, or improving documentation.
+
+**Want to contribute?** Check out our [Contributing Guide](./CONTRIBUTING.md) to get started.
+
+### Running Tests
+
+To run the test suite:
+
+```bash
+cd cli
+bun test
 ```
 
-**Windows (CMD):**
-```cmd
-set HTTPS_PROXY=http://your-proxy-server:port
-codebuff
+**For interactive E2E testing**, install tmux:
+
+```bash
+# macOS
+brew install tmux
+
+# Ubuntu/Debian
+sudo apt-get install tmux
+
+# Windows (via WSL)
+wsl --install
+sudo apt-get install tmux
 ```
 
-To make it permanent, add the `export` or `set` line to your shell profile (e.g. `~/.bashrc`, `~/.zshrc`, or Windows System Environment Variables).
+See [cli/src/__tests__/README.md](cli/src/__tests__/README.md) for comprehensive testing documentation.
+
+Some ways you can help:
+
+- 🐛 **Fix bugs** or add features
+- 🤖 **Create specialized agents** and publish them to the Agent Store
+- 📚 **Improve documentation** or write tutorials
+- 💡 **Share ideas** in our [GitHub Issues](https://github.com/CodebuffAI/codebuff/issues)
+
+## Get started
+
+### Install
+
+**CLI**: `npm install -g codebuff`
+
+**SDK**: `npm install @codebuff/sdk`
+
+**Freebuff (free)**: `npm install -g freebuff`
+
+### Resources
+
+**Documentation**: [codebuff.com/docs](https://codebuff.com/docs)
+
+**Community**: [Discord](https://codebuff.com/discord)
 
-**Supported environment variables:**
+**Issues & Ideas**: [GitHub Issues](https://github.com/CodebuffAI/codebuff/issues)
 
-| Variable | Purpose |
-|---|---|
-| `HTTPS_PROXY` / `https_proxy` | Proxy for HTTPS requests (recommended) |
-| `HTTP_PROXY` / `http_proxy` | Fallback proxy for HTTP requests |
-| `NO_PROXY` / `no_proxy` | Comma-separated list of hostnames to bypass the proxy (port suffixes are ignored) |
+**Contributing**: [CONTRIBUTING.md](./CONTRIBUTING.md) - Start here to contribute!
 
-Both `http://` and `https://` proxy URLs are supported. Proxy authentication is supported via URL credentials (e.g. `http://user:password@proxy:port`).
+**Support**: [support@codebuff.com](mailto:support@codebuff.com)
 
-## Feedback
+## Star History
 
-We value your input! Please email your feedback to `founders@codebuff.com`. Thank you for using Codebuff!
+[![Star History Chart](https://api.star-history.com/svg?repos=CodebuffAI/codebuff&type=Date)](https://www.star-history.com/#CodebuffAI/codebuff&Date)