@kodadev/koda-cli 0.1.8

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 Google LLC
+
+   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,273 @@
+# Koda CLI
+
+[![Koda CLI CI](https://github.com/koda-ai/koda-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/koda-ai/koda-cli/actions/workflows/ci.yml)
+[![Version](https://img.shields.io/npm/v/@koda-ai/koda-cli)](https://www.npmjs.com/package/@koda-ai/koda-cli)
+[![License](https://img.shields.io/github/license/koda-ai/koda-cli)](https://github.com/koda-ai/koda-cli/blob/main/LICENSE)
+
+![Koda CLI Screenshot](./docs/assets/koda-screenshot.png)
+
+Koda CLI is an open-source AI agent that brings the power of Koda directly into your terminal. It provides lightweight access to Koda, giving you the most direct path from your prompt to our model.
+
+## 🚀 Why Koda CLI?
+
+- **🎯 Free tier**: Generous trial limits available with GitHub sign-in
+- **🧠 Powerful Koda 2.5 Pro**: Access to 1M token context window
+- **🔧 Built-in tools**: Web search grounding, file operations, shell commands, web fetching
+- **🔌 Extensible**: MCP (Model Context Protocol) support for custom integrations
+- **💻 Terminal-first**: Designed for developers who live in the command line
+- **🛡️ Open source**: Apache 2.0 licensed
+
+## 📦 Installation
+
+### Quick Install
+
+#### Run instantly with npx
+
+```bash
+# Using npx (no installation required)
+npx https://github.com/koda-ai/koda-cli
+```
+
+#### Install globally with npm
+
+```bash
+npm install -g @koda-ai/koda-cli
+```
+
+#### Install globally with Homebrew (macOS/Linux)
+
+```bash
+brew install koda-cli
+```
+
+#### System Requirements
+
+- Node.js version 20 or higher
+- macOS, Linux, or Windows
+
+## 📋 Key Features
+
+### Code Understanding & Generation
+
+- Query and edit large codebases
+- Generate new apps from PDFs, images, or sketches using multimodal capabilities
+- Debug issues and troubleshoot with natural language
+
+### Automation & Integration
+
+- Automate operational tasks like querying pull requests or handling complex rebases
+- Use MCP servers to connect new capabilities, including [media generation with Imagen, Veo or Lyria](https://github.com/GoogleCloudPlatform/vertex-ai-creative-studio/tree/main/experiments/mcp-genmedia)
+- Run non-interactively in scripts for workflow automation
+
+### Advanced Capabilities
+
+- Ground your queries with built-in web search for real-time information
+- Conversation checkpointing to save and resume complex sessions
+- Custom context files (KODA.md) to tailor behavior for your projects
+
+### GitHub Integration
+
+Integrate Koda CLI directly into your GitHub workflows with [**Koda CLI GitHub Action**](https://github.com/koda-ai/run-koda-cli):
+
+- **Pull Request Reviews**: Automated code review with contextual feedback and suggestions
+- **Issue Triage**: Automated labeling and prioritization of GitHub issues based on content analysis
+- **On-demand Assistance**: Mention `@koda-cli` in issues and pull requests for help with debugging, explanations, or task delegation
+- **Custom Workflows**: Build automated, scheduled and on-demand workflows tailored to your team's needs
+
+## 🔐 Authentication Options
+
+Choose the authentication method that best fits your needs:
+
+### Option 1: Sign in with GitHub (recommended)
+
+**✨ Best for:** Most users who want the hosted free tier or organization-managed seats.
+
+**Benefits:**
+
+- **No manual key rotation** – the CLI performs the GitHub device flow and caches tokens securely.
+- **Automatic provisioning** – optionally exchange the GitHub token for a managed Koda API key.
+- **Shared configuration** – credentials are stored in `~/.config/koda/credentials.json` for reuse.
+
+1. Ensure the CLI has access to a GitHub OAuth client ID. Packaged releases ship with one. If you are running from source, create a GitHub OAuth App with Device Flow enabled and export `GITHUB_CLIENT_ID=<your-client-id>`. You can customise scopes with `GITHUB_SCOPES` (defaults to `read:user user:email`).
+2. Launch the CLI and choose **Sign in with GitHub** when prompted. The terminal prints a verification URL and code; open the URL, enter the code, and approve the request.
+3. (Optional) Set `KODA_GITHUB_EXCHANGE_URL` to the endpoint provided by your Koda administrator to automatically mint a long-lived API key from the GitHub token. The CLI saves any tokens that are issued into `~/.config/koda/credentials.json` and makes them available for future sessions.
+
+```bash
+koda
+```
+
+### Option 2: Provide a Koda API key
+
+**✨ Best for:** Service accounts, CI jobs, or teams managing credentials centrally.
+
+**Benefits:**
+
+- **Deterministic access** – use the exact seat or quota assigned to the key.
+- **Script friendly** – works in headless and automated environments.
+- **Compatible** – works with cached GitHub tokens or explicit `KODA_API_KEY` secrets.
+
+```bash
+export KODA_API_KEY="YOUR_API_KEY"
+koda
+```
+
+Store the variable in an `.env` file, your shell profile, or `~/.config/koda/credentials.json` to reuse it across sessions.
+
+### Option 3: Continue without authentication (limited)
+
+**✨ Best for:** Exploring the interface or running local-only commands before connecting to the service.
+
+You can skip authentication from the initial dialog or select **Skip** later via `/auth`. Model-backed features remain disabled until you sign in with GitHub or provide an API key.
+
+For detailed setup instructions, troubleshooting tips, and environment variable options see the [authentication guide](./docs/cli/authentication.md).
+
+## 🚀 Getting Started
+
+### Basic Usage
+
+#### Start in current directory
+
+```bash
+koda
+```
+
+#### Include multiple directories
+
+```bash
+koda --include-directories ../lib,../docs
+```
+
+#### Use specific model
+
+```bash
+koda -m koda-pro
+```
+
+#### Non-interactive mode for scripts
+
+```bash
+koda -p "Explain the architecture of this codebase"
+```
+
+### Quick Examples
+
+#### Start a new project
+
+````bash
+cd new-project/
+koda
+> Write me a Discord bot that answers questions using a FAQ.md file I will provide
+
+#### Analyze existing code
+```bash
+git clone https://github.com/koda-ai/koda-cli
+cd koda-cli
+koda
+> Give me a summary of all of the changes that went in yesterday
+````
+
+## 📚 Documentation
+
+### Getting Started
+
+- [**Quickstart Guide**](./docs/cli/index.md) - Get up and running quickly
+- [**Authentication Setup**](./docs/cli/authentication.md) - Detailed auth configuration
+- [**Configuration Guide**](./docs/cli/configuration.md) - Settings and customization
+- [**Keyboard Shortcuts**](./docs/keyboard-shortcuts.md) - Productivity tips
+
+### Core Features
+
+- [**Commands Reference**](./docs/cli/commands.md) - All slash commands (`/help`, `/chat`, `/mcp`, etc.)
+- [**Checkpointing**](./docs/checkpointing.md) - Save and resume conversations
+- [**Memory Management**](./docs/tools/memory.md) - Using KODA.md context files
+- [**Token Caching**](./docs/cli/token-caching.md) - Optimize token usage
+
+### Tools & Extensions
+
+- [**Built-in Tools Overview**](./docs/tools/index.md)
+  - [File System Operations](./docs/tools/file-system.md)
+  - [Shell Commands](./docs/tools/shell.md)
+  - [Web Fetch & Search](./docs/tools/web-fetch.md)
+  - [Multi-file Operations](./docs/tools/multi-file.md)
+- [**MCP Server Integration**](./docs/tools/mcp-server.md) - Extend with custom tools
+- [**Custom Extensions**](./docs/extension.md) - Build your own commands
+
+### Advanced Topics
+
+- [**Architecture Overview**](./docs/architecture.md) - How Koda CLI works
+- [**IDE Integration**](./docs/ide-integration.md) - VS Code companion
+- [**Sandboxing & Security**](./docs/sandbox.md) - Safe execution environments
+- [**Enterprise Deployment**](./docs/deployment.md) - Docker, system-wide config
+- [**Telemetry & Monitoring**](./docs/telemetry.md) - Usage tracking
+- [**Tools API Development**](./docs/core/tools-api.md) - Create custom tools
+
+### Configuration & Customization
+
+- [**Settings Reference**](./docs/cli/configuration.md) - All configuration options
+- [**Theme Customization**](./docs/cli/themes.md) - Visual customization
+- [**.koda Directory**](./docs/gemini-ignore.md) - Project-specific settings
+- [**Environment Variables**](./docs/cli/configuration.md#environment-variables)
+
+### Troubleshooting & Support
+
+- [**Troubleshooting Guide**](./docs/troubleshooting.md) - Common issues and solutions
+- [**FAQ**](./docs/troubleshooting.md#frequently-asked-questions) - Quick answers
+- Use `/bug` command to report issues directly from the CLI
+
+### Using MCP Servers
+
+Configure MCP servers in `~/.koda/settings.json` to extend Koda CLI with custom tools:
+
+```text
+> @github List my open pull requests
+> @slack Send a summary of today's commits to #dev channel
+> @database Run a query to find inactive users
+```
+
+See the [MCP Server Integration guide](./docs/tools/mcp-server.md) for setup instructions.
+
+## 🤝 Contributing
+
+We welcome contributions! Koda CLI is fully open source (Apache 2.0), and we encourage the community to:
+
+- Report bugs and suggest features
+- Improve documentation
+- Submit code improvements
+- Share your MCP servers and extensions
+
+See our [Contributing Guide](./CONTRIBUTING.md) for development setup, coding standards, and how to submit pull requests.
+
+Check our [Official Roadmap](https://github.com/orgs/koda-ai/projects/1/) for planned features and priorities.
+
+## 🧭 Documentation Site
+
+The Markdown guides in `docs/` are published with a lightweight Docusaurus site located in `docs-website/`. To work on the docs UI locally:
+
+- `npm run docs:install` (first time only) installs the isolated Docusaurus dependencies.
+- `npm run docs:start` launches the development server at `http://localhost:3000`.
+- `npm run docs:build` creates a production static build under `docs-website/build/`.
+
+The docs folder is excluded from the main CLI bundle, so these commands are entirely optional for regular builds.
+
+## 📖 Resources
+
+- **[Official Roadmap](./ROADMAP.md)** - See what's coming next
+- **[NPM Package](https://www.npmjs.com/package/@koda-ai/koda-cli)** - Package registry
+- **[GitHub Issues](https://github.com/koda-ai/koda-cli/issues)** - Report bugs or request features
+- **[Security Advisories](https://github.com/koda-ai/koda-cli/security/advisories)** - Security updates
+
+### Uninstall
+
+See the [Uninstall Guide](docs/Uninstall.md) for removal instructions.
+
+## 📄 Legal
+
+- **License**: [Apache License 2.0](LICENSE)
+- **Terms of Service**: [Terms & Privacy](./docs/tos-privacy.md)
+- **Security**: [Security Policy](SECURITY.md)
+
+---
+
+<p align="center">
+  Built with ❤️ by the Koda team and the open source community
+</p>