@menteeai/menteeswe 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 MenteE
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,80 @@
+# MenteE SWE
+
+An autonomous **SWE agent in your terminal**. It investigates your repository, plans, makes minimal edits, runs your tests, debugs failures, and reports back with evidence — never claiming success without proof.
+
+**Bring your own intelligence:** MenteE is model-agnostic. Kimi, GLM, and more plug in as replaceable providers. The product is the harness: tools, verification loop, context management, and orchestration.
+
+## Install
+
+```bash
+npm install -g menteeswe
+```
+
+## Quick start
+
+```bash
+# one-time configuration (choose Kimi or GLM, paste API key)
+mentee config
+
+# run a task in your project
+cd your-project
+mentee "fix the failing auth tests"
+```
+
+Or try without installing: `npx menteeswe "your task"`.
+
+## Providers
+
+| Provider | Default model | Env var |
+|---|---|---|
+| Kimi (Moonshot) | `kimi-k2.7-code` | `MENTEE_KIMI_API_KEY` |
+| GLM (Zhipu CN) | `glm-4.6` | `MENTEE_GLM_API_KEY` |
+| Z.ai (GLM international) | `glm-4.6` | `MENTEE_ZAI_API_KEY` |
+| mock (testing) | — | no key needed |
+
+Select with `-p kimi` / `-p glm` / `-p zai`, override the model with `-m <id>`.
+
+## Inside the TUI
+
+The interactive CLI stays open between tasks. Type a task and press Enter, or use slash commands:
+
+```text
+/provider zai        switch provider (kimi, glm, zai, mock)
+/model glm-4.5-air   set the model for the current provider
+/key <api-key>       add the API key for the current provider (saved to ~/.mentee/config.json)
+/help                list commands
+/exit                quit
+```
+
+## Safety model
+
+- **safe** — read-only commands (`git status`, `npm test`, `ls`) run automatically
+- **restricted** — installs, git history changes → interactive approval (`y` / `a` / `n`), or auto-approve with `--yes`
+- **dangerous** — `rm -rf`, `sudo`, force pushes → always blocked
+
+All file edits are constrained to the current workspace. Sessions log to `~/.mentee/logs/`.
+
+## CLI
+
+```text
+mentee [task...]                  run a task (interactive TUI in a terminal)
+mentee config                     provider/key setup wizard
+mentee -p glm "task"              choose provider
+mentee -m kimi-k2-turbo-preview   override model
+mentee --yes --no-tui "task"      headless mode for scripts/CI
+```
+
+## Development
+
+```bash
+npm install
+npm run dev        # run from source
+npm test           # unit + integration tests (mock provider, no API keys needed)
+npm run typecheck  # tsc --noEmit
+npm run build      # bundle to dist/
+npm run eval       # eval suite against fixture repos (mock provider)
+```
+
+## Architecture
+
+See [../MAIN_GOAL.md](../MAIN_GOAL.md) for the full product plan: phases, verification loop, subagents, context engineering, and routing roadmap.