@papert-code/papert-code 0.2.4 → 0.3.0

package/LICENSE

@@ -0,0 +1,203 @@
+
+                                 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
+  Copyright 2025 Qwen
+
+   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,197 @@
+# Papert Code
+
+Papert Code is a terminal-native AI coding companion that automates everyday developer workflows. It reads, edits, and generates code across large repositories, automates shell tasks with safety rails, and exposes the same capabilities through a TypeScript SDK and a VS Code companion extension.
+
+- Terminal-first agent with `papert`, built for high-signal, multi-turn coding sessions.
+- Codebase-aware tools: reads and edits files, runs ripgrep queries, executes shell commands, and respects `.gitignore` + `.papertignore`.
+- Safety and control: structured plans, explicit approval modes (`plan`, `default`, `auto-edit`, `yolo`), and sandbox support (Seatbelt/macOS, Docker, Podman).
+- Extensible platform: user commands, subagents, Model Context Protocol (MCP) servers, and a TypeScript SDK for embedding Papert Code into your own apps.
+- Works with any OpenAI-compatible API; pick your own model, base URL, and keys.
+
+## Repository layout
+
+- `packages/cli` — the Papert Code CLI (interactive TUI, tools, settings, sandbox integration).
+- `packages/core` — core tool implementations, MCP plumbing, and shared services.
+- `packages/sdk-typescript` — programmatic access to Papert Code (streaming queries + full CLI runner).
+- `packages/test-utils` — helpers for integration/terminal tests.
+- `packages/vscode-ide-companion` — VS Code extension that mirrors the CLI features inside the editor.
+- `docs/` — user and contributor documentation.
+
+## Installation
+
+### Prerequisites
+
+- Node.js **>= 20**
+
+### Install from npm
+
+```bash
+npm install -g @papert-code/papert-code
+papert --version
+```
+
+### Install from source
+
+```bash
+git clone https://github.com/azharlabs/papert-code.git
+cd papert-code
+npm install
+npm install -g .
+```
+
+## Configure a model provider
+
+Papert Code speaks the OpenAI-compatible API. Set your provider values via environment variables or `.env`/`.papert/.env` files:
+
+```bash
+export OPENAI_API_KEY="your_api_key"
+export OPENAI_BASE_URL="https://api.your-provider.com/v1"   # optional if using api.openai.com
+export OPENAI_MODEL="your-model-id"                        # e.g. gpt-4o-mini
+```
+
+You can also pass flags per session:
+
+```bash
+papert --model gpt-4o-mini --base-url https://api.openai.com/v1
+```
+
+## Quick start
+
+```bash
+papert
+
+# Example prompts
+> Give me a map of the main services in this repo.
+> Refactor the auth middleware for clearer error handling.
+> Generate integration tests for the payment flow.
+```
+
+### Everyday commands
+
+- `/help` — list commands
+- `/clear` — wipe the conversation
+- `/compress` — shrink history to stay within context limits
+- `/stats` — show token and tool usage
+- `/exit` — quit the session
+
+Keyboard shortcuts: `Ctrl+C` cancels the current turn, `Ctrl+D` exits on an empty line, arrow keys navigate history.
+
+## Core capabilities
+
+- **Repository awareness**: traverses large codebases, respects `.gitignore` and `.papertignore`, and uses ripgrep for fast search.
+- **Structured editing**: reads and writes files with minimal diffs; keeps edits scoped and reversible.
+- **Shell automation**: runs commands with approval; supports long-running tasks and streaming output.
+- **Planning and approvals**: choose how cautious the agent should be:
+  - `plan`: always propose a plan before acting
+  - `default`: ask for confirmation on impactful operations
+  - `auto-edit`: auto-approve safe edits, prompt for risky ones
+  - `yolo`: auto-approve everything (use sparingly)
+- **Sandboxing**: optional seatbelt (macOS) or container sandboxes (Docker/Podman) to isolate filesystem and network access.
+- **Extensibility**:
+  - `.papert/commands/` for custom slash-commands
+  - `.papert/agents/` for specialized subagents
+  - MCP servers for external toolchains and data sources
+
+## Project settings and ignore files
+
+Papert Code looks for `.papert/settings.json` in your project or `~/.papert/settings.json` for user defaults. Example:
+
+```json
+{
+  "model": "gpt-4o-mini",
+  "approvalMode": "default",
+  "tool": {
+    "core": ["read_file", "write_file", "run_terminal_cmd"],
+    "exclude": ["ShellTool(rm )"]
+  },
+  "sandbox": {
+    "enabled": false
+  }
+}
+```
+
+Use `.papertignore` to exclude directories or files from context collection (same semantics as `.gitignore`). Environment variables can live in `.papert/.env` (project-scoped) or `~/.papert/.env` (user-scoped).
+
+## TypeScript SDK
+
+Install the SDK:
+
+```bash
+npm install @papert-code/sdk-typescript
+```
+
+### Streaming queries
+
+```typescript
+import { query } from '@papert-code/sdk-typescript';
+
+for await (const message of query({
+  prompt: 'List the services in this repo and summarize their responsibilities.',
+  options: { cwd: '/path/to/project', model: 'gpt-4o-mini' },
+})) {
+  if (message.type === 'assistant') {
+    console.log(message.message.content);
+  }
+  if (message.type === 'result') {
+    console.log('Finished');
+  }
+}
+```
+
+### Drive the full CLI
+
+```typescript
+import { createPapertAgent } from '@papert-code/sdk-typescript';
+
+const agent = await createPapertAgent({
+  cliArgs: {
+    model: 'gpt-4o-mini',
+    approvalMode: 'auto-edit', // plan | default | auto-edit | yolo
+    apiKey: process.env.OPENAI_API_KEY,
+    baseUrl: 'https://api.openai.com/v1'
+  },
+});
+
+const { stdout, exitCode } = await agent.runPrompt(
+  'Summarize outstanding TODOs by directory',
+  { extraArgs: ['--output-format', 'json'] },
+);
+
+console.log(stdout, exitCode);
+```
+
+SDK features:
+
+- Multi-turn streaming API with tool awareness.
+- Permission hooks (`canUseTool`), custom tool allow/deny lists, and MCP server wiring.
+- Abort support via `AbortController`, per-call environment overrides, and subagent configuration.
+- Works with the installed `papert` binary or a specified CLI path.
+
+Examples live under `packages/sdk-typescript/examples` (ESM, no ts-node required).
+
+## VS Code companion
+
+`packages/vscode-ide-companion` mirrors the CLI experience inside VS Code: native diffing, context awareness, and the same approval modes. Build it with `npm run build:vscode` or install from the marketplace once published.
+
+## Development
+
+Common scripts:
+
+- `npm run build` — build the CLI bundle
+- `npm test` — run workspace tests in parallel
+- `npm run lint` / `npm run lint:ci` — lint source and tests
+- `npm run typecheck` — TypeScript checks
+- `npm run build:all` — CLI + sandbox + VS Code companion
+- `npm run clean` — remove build artifacts and generated files
+
+See `CONTRIBUTING.md` for full contributor guidance and sandbox notes.
+
+## Troubleshooting
+
+- Check `docs/support/troubleshooting.md` for common fixes.
+- Verify your provider configuration (`OPENAI_API_KEY`, `OPENAI_BASE_URL`, `OPENAI_MODEL`).
+- Use `/stats` to see context usage and `/compress` to shrink history if you hit limits.
+
+## License
+
+Apache 2.0, see `LICENSE`.