Metadata-Version: 2.4
Name: gemcode
Version: 0.3.96
Summary: Local-first coding agent on Google Gemini + ADK
Author: GemCode Contributors
License:                                  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.
        
           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.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor.
        
           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.
        
           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, shall any Contributor be liable
              to You for damages, including any direct, indirect, special,
              incidental, or consequential damages arising in any way out of the
              use of the Work.
        
           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.
        
           END OF TERMS AND CONDITIONS
        
        
Project-URL: Homepage, https://github.com/spiderdev27/GemCode
Project-URL: Repository, https://github.com/spiderdev27/GemCode
Project-URL: Issues, https://github.com/spiderdev27/GemCode/issues
Keywords: ai,agent,coding,gemini,adk,cli,tui
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Topic :: Software Development
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Terminals
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: google-adk>=1.0.0
Requires-Dist: google-genai>=1.0.0
Requires-Dist: python-dotenv>=1.0.0
Requires-Dist: rich>=13.0.0
Requires-Dist: prompt_toolkit>=3.0.0
Provides-Extra: dev
Requires-Dist: pytest>=8.0.0; extra == "dev"
Requires-Dist: pytest-asyncio>=0.24.0; extra == "dev"
Provides-Extra: mcp
Requires-Dist: mcp>=1.0.0; extra == "mcp"
Dynamic: license-file

# GemCode User Manual

This document is the primary user-facing manual for GemCode. It explains the product at a high level and points to the subsystem-specific documentation pages that provide production-grade depth.

## What GemCode is
GemCode is a local-first coding agent built around Google Gemini and the Google Agent Development Kit (ADK). It operates against a chosen project root and combines:
- a configuration model
- a runtime runner
- a root language-model agent
- a configurable tool inventory
- project-local state under `.gemcode/`

GemCode is designed for repository-native work rather than copy-paste chat workflows.

## Runtime modes

| Mode | Purpose |
|---|---|
| One-shot CLI | Single prompt/response runs |
| REPL | Stateful terminal interaction |
| TUI | Scrollback terminal UI over the REPL runtime |
| IDE stdio | Editor integration over JSONL stdin/stdout |
| Kaira | Priority-queue scheduler for background jobs |
| Live audio | Microphone-driven Gemini Live sessions |

## Recommended reading order

### 1. Setup and first use
- [`../docs/install.md`](../docs/install.md)

### 2. Interactive use
- [`../docs/cli-and-repl.md`](../docs/cli-and-repl.md)

### 3. Configuration and local assets
- [`../docs/configuration.md`](../docs/configuration.md)

### 4. Tooling and safety model
- [`../docs/tools-and-permissions.md`](../docs/tools-and-permissions.md)

### 5. Optional capability bundles
- [`../docs/capabilities.md`](../docs/capabilities.md)

### 6. Integrations
- [`../docs/integrations.md`](../docs/integrations.md)
- [`../docs/web-ui-contract.md`](../docs/web-ui-contract.md)

### 7. Operations and release
- [`../docs/operations.md`](../docs/operations.md)

### 8. `.gemcode/` state reference
- [`../docs/reference-gemcode-state.md`](../docs/reference-gemcode-state.md)

### 9. Architecture deep dive
- [`../docs/architecture.md`](../docs/architecture.md)

## Quickstart

### Install
```bash
cd gemcode
python3 -m venv .venv
source .venv/bin/activate
python3 -m pip install -e ".[dev]"
```

### Set your API key
```bash
export GOOGLE_API_KEY="your-key"
```

### Start GemCode against a project
```bash
gemcode -C /path/to/project
```

### One-shot run
```bash
gemcode -C /path/to/project "Explain this repository"
```

### Mutating run
```bash
gemcode -C /path/to/project --yes "Fix the failing tests"
```

## Essential concepts

### Project root
Every GemCode run is anchored to a project root. This determines:
- what files are visible
- where `.gemcode/` state is stored
- what instruction files are loaded
- which repo-local assets are active

### `.gemcode/`
GemCode stores project-local state under `.gemcode/`, including:
- sessions
- logs
- artifacts
- memory
- skills
- rules
- output styles
- hooks
- integration config

Reference:
- [`../docs/reference-gemcode-state.md`](../docs/reference-gemcode-state.md)

### Project instruction files
GemCode supports project instruction files loaded by the agent layer. The live code treats `gemcode.md` as the primary project instruction file and supports `GEMINI.md` as a compatibility path.

Reference:
- [`../docs/configuration.md`](../docs/configuration.md)

### GemSkills
GemSkills are reusable prompt playbooks stored under:
- `.gemcode/skills/<name>/SKILL.md`
- `~/.gemcode/skills/<name>/SKILL.md`

They support:
- creation
- session loading
- one-shot invocation
- iterative editing

### Permissions
GemCode combines:
- workspace trust
- permission mode
- allow/deny settings
- blanket approval flags
- interactive approval prompts

Reference:
- [`../docs/tools-and-permissions.md`](../docs/tools-and-permissions.md)

## Common commands

### Inspect models
```bash
gemcode models
```

### Start the REPL
```bash
gemcode -C .
```

### Attach a file to a one-shot turn
```bash
gemcode -C . --attach ./report.pdf "Summarize this"
```

### Run the scheduler
```bash
gemcode kaira -C .
```

### Start the IDE bridge
```bash
gemcode ide --stdio
```

### Run live audio
```bash
gemcode live-audio -C .
```

## REPL command highlights

| Command | Purpose |
|---|---|
| `/help` | Command summary |
| `/status` | Model, capabilities, context, and runtime telemetry |
| `/context` | Context pressure and prompt budget telemetry |
| `/cost` | Token and cost estimate summary |
| `/attach` | Queue file attachments for the next turn |
| `/trust` | Manage workspace trust |
| `/init` | Generate project instructions |
| `/skills` | List skills |
| `/gemskill` | Load a skill into the session prompt |
| `/style` | Set session output style |
| `/rules` | Inspect active rules |
| `/diff` | Show current diff/checkpoint diff |
| `/rewind` | Restore checkpoints |
| `/review` | Run a review workflow |
| `/eval` | Run evaluation gates |
| `/kaira` | Show scheduler usage help |

Detailed behavior:
- [`../docs/cli-and-repl.md`](../docs/cli-and-repl.md)

## Capability overview

| Capability | What it adds |
|---|---|
| Deep research | research-focused tool routing and optional dedicated model path |
| Embeddings | semantic search and optional embedding-backed memory |
| Memory | retrieval-oriented persistent memory |
| Browser/computer use | Playwright-backed browser automation and inspection |
| Live audio | Gemini Live microphone sessions |

Detailed behavior:
- [`../docs/capabilities.md`](../docs/capabilities.md)

## Integrations overview

| Integration | Entry point |
|---|---|
| IDE bridge | `gemcode ide --stdio` |
| Web/SSE | documented in `docs/web-ui-contract.md` |
| MCP | `.gemcode/mcp.json` |
| OpenAPI | `.gemcode/openapi/` |

Detailed behavior:
- [`../docs/integrations.md`](../docs/integrations.md)

## Release and maintenance
Package version lives in:
- `gemcode/pyproject.toml`

Release operations, troubleshooting, and PyPI workflow are documented in:
- [`../docs/operations.md`](../docs/operations.md)

## Documentation policy
This manual is intentionally concise. The detailed production documentation lives under `docs/` and is organized by subsystem and operator concern so it can stay accurate as GemCode evolves.
