pichu 0.1.0__tar.gz

pichu-0.1.0/LICENSE

@@ -0,0 +1,178 @@
+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
+
+Copyright 2025 pichu Contributors

pichu-0.1.0/PKG-INFO

@@ -0,0 +1,363 @@
+Metadata-Version: 2.4
+Name: pichu
+Version: 0.1.0
+Summary: ⚡ pichu — code, compile, conquer
+Author: pichu Contributors
+License-Expression: Apache-2.0
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: beautifulsoup4>=4.12.3
+Requires-Dist: click>=8.1.7
+Requires-Dist: ddgs>=8.1.1
+Requires-Dist: fastmcp>=2.12.0
+Requires-Dist: html2text>=2024.2.26
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: lxml>=5.0
+Requires-Dist: openai>=1.52.0
+Requires-Dist: pathspec>=0.11.0
+Requires-Dist: platformdirs>=4.3.0
+Requires-Dist: playwright>=1.50.0
+Requires-Dist: pydantic>=2.9.0
+Requires-Dist: pypdf>=5.3.0
+Requires-Dist: python-dotenv>=1.0.1
+Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: rich>=13.9.0
+Requires-Dist: tenacity>=9.0.0
+Requires-Dist: tiktoken>=0.9.0
+Requires-Dist: tomlkit>=0.13.2
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2.post1; extra == "dev"
+Requires-Dist: mypy>=1.11.0; extra == "dev"
+Requires-Dist: pre-commit>=3.7.0; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0.0; extra == "dev"
+Requires-Dist: ruff>=0.5.0; extra == "dev"
+Requires-Dist: twine>=5.1.1; extra == "dev"
+Requires-Dist: types-pyyaml>=6.0.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+  <img src="assets/logo.png" alt="pichu Logo" width="200" /><br/>
+  <strong>⚡ pichu — code, compile, conquer.</strong><br/>
+  Coding agent that lives in your terminal.
+</p>
+
+---
+
+<p align="center">
+  <img src="assets/demo.gif" alt="pichu Demo" />
+</p>
+
+## Features
+
+- **Composable tooling stack** — file editing/search, shell, web research, task tools, and memory tools
+- **Context management** — token-aware context windows with compaction, tool-output pruning, and usage tracking
+- **MCP integration** — connect and manage external MCP servers, with namespaced MCP tools available alongside built-ins
+- **Sub-agent orchestration** — delegate work to specialized sub-agents with isolated context, scoped tool access, and resume/background support
+- **28 slash commands** — operational control for config, diagnostics, sessions, permissions, hooks, tasks, MCP, GitHub setup, and more
+- **Web tooling with guardrails** — structured search/fetch, citation-style outputs, cache modes, rate limits, provenance checks, and PDF extraction
+- **Session system** — JSONL transcript persistence, metadata indexing, resume/continue, checkpoints, rewind, and forked sessions
+- **Memory system** — global + project memory stores, AGENTS hierarchy loading, and searchable categorized memories
+- **Task orchestration** — persistent task lists with status transitions, dependency graphs, ownership, and cross-session coordination
+- **Hooks automation** — lifecycle hooks (`PreToolUse`, `PostToolUse`, `Stop`, `PreCompact`, `SubagentStop`, etc.) with matcher-based routing
+- **Safety by default** — approval policies, rule-based permission engine, dangerous-command detection, and filesystem sandbox enforcement
+- **Reliability controls** — LLM retry/backoff, loop detection, context compaction, tool-output pruning, and runtime/audit logging
+
+## Quick Start
+
+### 1) Prerequisites
+
+- Python 3.13+
+- [uv](https://docs.astral.sh/uv/) (recommended)
+- An LLM API key (for example, [OpenRouter](https://openrouter.ai/))
+
+### 2) Install
+
+```bash
+# uv tool install (recommended for end users)
+uv tool install pichu
+
+# pip
+pip install pichu
+
+# Linux/macOS one-line installer
+curl -fsSL https://raw.githubusercontent.com/yeabwang/pichu/main/install.sh | bash
+```
+
+### 3) Configure model credentials
+
+Interactive (recommended):
+
+```bash
+pichu
+/login
+```
+
+Environment variable:
+
+```bash
+# Linux / macOS
+export LLM_API_KEY="your-key-here"
+
+# Windows PowerShell
+$env:LLM_API_KEY = "your-key-here"
+```
+
+Base URL and model are configured via `/login` (stored in `~/.pichu/config.toml`).
+
+### 4) Initialize project files
+
+Inside a `pichu` session in your project directory, run:
+
+```bash
+/init
+```
+
+This generates `AGENTS.md`, `AGENTS.local.md`, and `.pichu/config.toml` for the current project.
+
+### 5) Run and validate
+
+```bash
+# Interactive mode
+pichu
+
+# Single prompt
+pichu "explain this repo"
+
+# Run tests
+uv run pytest -q
+
+```
+
+### CLI Options
+
+```
+pichu [PROMPT]              Run interactively, or execute a single prompt
+  -c, --cwd PATH            Set working directory for the agent
+  -C, --continue             Resume the most recent session in this directory
+  -r, --resume ID_OR_TITLE   Resume a specific session by ID or title
+```
+
+## Commands
+
+pichu includes 28 slash commands for runtime control. Type `/help` inside a session for the full list.
+
+| Command          | Description                                      |
+| ---------------- | ------------------------------------------------ |
+| `/agents`      | List loaded sub-agents                           |
+| `/clear`       | Clear conversation history                       |
+| `/compact`     | Compact context with optional focus instructions |
+| `/config`      | View or open settings configuration              |
+| `/context`     | Visualize context token usage                    |
+| `/copy`        | Copy last response to clipboard                  |
+| `/cost`        | Token usage and cost statistics                  |
+| `/debug`       | Troubleshoot current session                     |
+| `/doctor`      | Health check installation                        |
+| `/exit`        | Exit the session                                 |
+| `/export`      | Export conversation to file                      |
+| `/fork`        | Fork this session into a new branch              |
+| `/github`      | Setup/status for GitHub MCP tasks                |
+| `/help`        | Display help information and available commands  |
+| `/hooks`       | Display registered lifecycle hooks               |
+| `/init`        | Initialize project with AGENTS.md                |
+| `/login`       | Configure API key, provider, and model           |
+| `/mcp`         | Manage MCP server connections                    |
+| `/memory`      | Edit memory files (AGENTS.md)                    |
+| `/model`       | Switch or view the AI model                      |
+| `/permissions` | Show approval policy and permission rules        |
+| `/rename`      | Rename the current session                       |
+| `/rewind`      | Rewind to a previous checkpoint                  |
+| `/sessions`    | List and manage saved sessions                   |
+| `/stats`       | Usage visualizations (tokens, turns, duration)   |
+| `/status`      | Version, model, and connectivity info            |
+| `/tasks`       | List and manage tasks                            |
+| `/theme`       | Change color theme                               |
+
+## Built-in Tools
+
+The agent has access to 16 built-in tools:
+
+| Tool            | Description                               |
+| --------------- | ----------------------------------------- |
+| `read_file`   | Read file contents                        |
+| `write_file`  | Create or overwrite files                 |
+| `edit_file`   | Apply targeted edits to existing files    |
+| `batch_apply` | Apply multiple file operations atomically |
+| `shell`       | Execute shell commands                    |
+| `list_dir`    | List directory contents                   |
+| `grep`        | Search file contents with regex           |
+| `glob`        | Find files by name pattern                |
+| `web_search`  | Search the web                            |
+| `web_fetch`   | Fetch and extract web page content        |
+| `task_create` | Create a task in the task list            |
+| `task_update` | Update task status or metadata            |
+| `task_get`    | Get details of a specific task            |
+| `task_list`   | List all tasks                            |
+| `memory`      | Save, search, or manage project memory    |
+| `subagent_*`  | Delegate work to a specialized sub-agent  |
+
+## Configuration
+
+Configuration is loaded in this order (later sources override earlier ones):
+
+1. **Code defaults** — sensible baseline values
+2. **System config** — `~/.pichu/config.toml`
+3. **Project config** — `.pichu/config.toml` (searched upward from cwd)
+4. **System .env** — `~/.pichu/.env` (used for persisted keys from `/login`)
+5. **Project .env** — `.env` in the current working directory
+6. **Environment overrides** — `LLM_API_KEY` and `PICHU_DEBUG`
+
+Behavior instructions for the agent are loaded from `AGENT.md` in the nearest discovered `.pichu` directory.
+
+## Troubleshooting
+
+When something goes wrong, use this recovery flow:
+
+1. Run `/doctor` for a full installation + config health check.
+2. Run `/status` to verify model/provider/session state.
+3. Run `/debug` for runtime diagnostics in the current session.
+4. Check logs in `logs/app/` and `logs/security/audit.log` for concrete errors.
+
+Common cases:
+
+- **API failures (401/403/5xx):** re-run `/login`, then confirm `LLM_API_KEY` and `llm.base_url` / `llm.model` in `~/.pichu/config.toml`.
+- **MCP connection issues:** run `/mcp` to inspect configured servers and connection state.
+- **Sandbox violations:** review `[safety.sandbox]` in `.pichu/config.toml` and allowed path settings.
+
+### Environment Variables
+
+| Variable              | Required | Description                                        |
+| --------------------- | -------- | -------------------------------------------------- |
+| `LLM_API_KEY`       | Yes      | API key for your LLM provider                      |
+| `SERPER_API_KEY`    | No       | API key for web search (Serper)                    |
+| `PICHU_DEBUG`       | No       | Enable debug logging (`true`/`false`)          |
+| `PICHU_PROJECT_DIR` | No       | Project config directory name (default:`.pichu`) |
+| `PICHU_CONFIG_FILE` | No       | Config file name (default:`config.toml`)         |
+
+## Development
+
+### Install
+
+Option A (recommended): use uv project sync + Makefile workflow
+
+```bash
+git clone https://github.com/yeabwang/pichu.git
+cd pichu
+
+uv venv
+
+uv sync --extra dev
+uv run pre-commit install
+```
+
+Option B: requirements-based install
+
+```bash
+git clone https://github.com/yeabwang/pichu.git
+cd pichu
+
+uv venv
+uv pip install -r requirements-dev.txt && uv pip install -e .
+```
+
+### Requirements Files
+
+| File                     | Contents                                  |
+| ------------------------ | ----------------------------------------- |
+| `requirements.txt`     | Runtime dependencies (core + web tooling) |
+| `requirements-dev.txt` | Core + testing, linting, and build tools  |
+
+Use the Makefile for common development workflows:
+
+```bash
+# Install dev dependencies + pre-commit hooks
+make dev
+
+# Common commands
+make format      # auto-format with ruff
+make lint        # lint with ruff
+make typecheck   # type-check with mypy
+make test        # run tests
+make test-cov    # tests + coverage report
+make build       # build package
+make clean       # remove caches & artifacts
+```
+
+### Run Tests
+
+```bash
+uv run pytest -q
+```
+
+### Project Bootstrap
+
+Inside a pichu session, run `/init` to generate a full `.pichu/config.toml` baseline and project guidance files. If these files are missing, startup now prompts you to run `/init`.
+
+### Build
+
+```bash
+make build                    # produces sdist + wheel in dist/
+# or: uv build
+```
+
+## Deployment
+
+### Docker
+
+```bash
+docker build -t pichu:latest .
+docker run --rm -it -e LLM_API_KEY=your-key -v "$(pwd)":/workspace pichu:latest
+```
+
+### CI
+
+GitHub Actions runs tests and builds on every push/PR — see `.github/workflows/ci.yml`.
+
+See [docs/deployment.md](docs/deployment.md) for full deployment details.
+
+## Architecture
+
+```
+pichu/
+├── main.py          CLI entrypoint — wires config → agent → TUI
+├── src/
+│   ├── agent/       Runtime orchestration loop, events, session lifecycle
+│   ├── client/      LLM transport and stream parsing
+│   ├── commands/    Slash command registry and 28 built-in handlers
+│   ├── config/      Configuration schema, loader, and merge logic
+│   ├── context/     Context window management and compaction
+│   ├── hooks/       Lifecycle hook framework
+│   ├── prompts/     System prompt construction
+│   ├── safety/      Approval policies, sandbox, and command risk checks
+│   ├── subagents/   Sub-agent loader/types/transcripts + bundled specs
+│   ├── tools/       Built-in and MCP tool implementations
+│   ├── ui/          Terminal rendering (Rich-based TUI)
+│   └── utils/       Sessions, memory, tasks, web helpers, and more
+├── tests/           Test suite (pytest)
+└── docs/            Module-level developer documentation
+```
+
+## Documentation
+
+Detailed developer guides for each module:
+
+- [Agent Module](docs/agent-module.md) — runtime loop, events, session lifecycle
+- [Client Module](docs/client-module.md) — LLM client, streaming, retry
+- [Commands Module](docs/commands-module.md) — slash command system
+- [Config Module](docs/config-module.md) — configuration schema and loading
+- [Context Module](docs/context-module.md) — context management and compaction
+- [Hooks Module](docs/hooks-module.md) — lifecycle hook engine
+- [Logging Module](docs/logging-module.md) — runtime and audit logging
+- [MCP Module](docs/mcp-module.md) — MCP server integration
+- [Safety Module](docs/safety-module.md) — approval and sandbox policies
+- [Sub-agents Module](docs/subagents-module.md) — sub-agent orchestration
+- [Task Management](docs/task-management.md) — task system architecture
+- [Tool Management](docs/tool-management.md) — tool registry and execution
+- [Utils Module](docs/utils-module.md) — shared runtime utilities
+- [Deployment](docs/deployment.md) — Docker, CI, and packaging
+
+## License
+
+Apache 2.0 — see [LICENSE](LICENSE).