@matheuskrumenauer/tanya 0.2.0-beta.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Matheus Weber
+
+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,235 @@
+# Tanya
+
+[![CI](https://github.com/matheusjkweber/tanya/actions/workflows/ci.yml/badge.svg)](https://github.com/matheusjkweber/tanya/actions/workflows/ci.yml)
+[![npm version](https://img.shields.io/npm/v/%40matheuskrumenauer%2Ftanya.svg)](https://www.npmjs.com/package/@matheuskrumenauer/tanya)
+[![license](https://img.shields.io/github/license/matheusjkweber/tanya.svg)](./LICENSE)
+[![node](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg)](./package.json)
+[![contributors](https://img.shields.io/github/contributors/matheusjkweber/tanya.svg)](https://github.com/matheusjkweber/tanya/graphs/contributors)
+
+Tanya is a live, tool-using AI CLI. It starts like Claude Code:
+
+```bash
+tanya
+```
+
+The first provider is DeepSeek. The provider layer is OpenAI-compatible, so future providers can be added with an API key, base URL, and model name.
+
+## Install
+
+Local development:
+
+```bash
+npm install
+npm run link:local
+tanya
+```
+
+From GitHub, once published:
+
+```bash
+npm install -g github:matheusjkweber/tanya
+```
+
+From npm, once published:
+
+```bash
+npm install -g @matheuskrumenauer/tanya
+```
+
+The unscoped `tanya` name is taken on npm, so the package publishes under the `@matheuskrumenauer` scope.
+
+## Contributing
+
+Start with [CONTRIBUTING.md](./CONTRIBUTING.md) for local setup, tool and
+skill-pack conventions, tests, and PR expectations.
+
+Beginner-friendly tasks are tagged
+[`good first issue`](https://github.com/matheusjkweber/tanya/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
+For roadmap context, read [docs/claude-code-gap-analysis.md](./docs/claude-code-gap-analysis.md).
+
+## Configuration
+
+Create `.env` from `.env.example`:
+
+```bash
+DEEPSEEK_API_KEY=...
+DEEPSEEK_BASE_URL=https://api.deepseek.com
+TANYA_MODEL=deepseek-chat
+```
+
+Use the reasoner profile for harder coding/planning tasks:
+
+```bash
+TANYA_PROFILE=reasoner
+```
+
+Or pass it per command:
+
+```bash
+tanya run --profile reasoner "Plan this refactor"
+tanya chat --profile reasoner
+```
+
+Custom OpenAI-compatible provider:
+
+```bash
+TANYA_PROVIDER=custom
+TANYA_API_KEY=...
+TANYA_BASE_URL=https://provider.example.com
+TANYA_MODEL=provider-model-name
+```
+
+Optional Obsidian logging:
+
+```bash
+TANYA_OBSIDIAN_VAULT=/path/to/Obsidian/Vault
+```
+
+When set, Tanya appends a summary of completed tasks to the vault daily note. `tanya run` also searches the vault for task-relevant notes and materializes safe excerpts into `.tania/context/obsidian` so they can be read as normal workspace context.
+
+DeepSeek documents its API as OpenAI-compatible for chat completions:
+https://api-docs.deepseek.com/
+
+## Backward compatibility
+
+The old `tania` command remains as a binary alias for `tanya`, so existing
+automation that runs `tania run --json` keeps working.
+
+Configuration reads `TANYA_*` variables first and falls back to legacy
+`TANIA_*` names when the new variable is absent. When only a legacy variable is
+used, Tanya prints a one-line deprecation warning. If both names are set,
+`TANYA_*` wins.
+
+The workspace state directory remains `.tania/` for historical compatibility.
+Existing run logs, context files, artifact materialization, and memory files are
+not moved or renamed.
+
+## Commands
+
+```bash
+tanya                         # live chat
+tanya chat --profile reasoner # live chat with the reasoner profile
+tanya ask "Explain this"      # one-shot answer
+tanya run "Fix the test"      # agent task with tools
+tanya run --profile reasoner "Fix this bug" # run with TANYA_PROFILE=reasoner
+tanya run --verify "npm run typecheck" --verify "npm run build" "Fix the test"
+tanya run --no-auto-brief "Fix the test" # skip deterministic project/artifact brief
+tanya run --no-obsidian-context "Fix the test" # skip Obsidian context retrieval
+tanya run --retries 2 "Fix this task" # retry blocked runs with context carry-forward
+tanya run --plan --retries 2 "Implement the feature" # reasoner plan plus retries
+tanya run --no-post-check "Long native build task" # skip independent typecheck/test re-checks
+tanya run --json "Fix lint"   # JSONL events for machine consumers
+tanya run --context-file ./context.json --prompt-file ./prompt.md
+tanya benchmark profiles      # list runnable regression benchmark profiles
+tanya benchmark run --all     # execute the benchmark suite locally
+tanya benchmark validate      # validate recent benchmark signatures
+tanya runs                    # show recent run logs with cost/status
+tanya video presets           # list available video presets
+tanya video one-terminal-simctl # generate the exact transparent terminal asset
+tanya providers test          # provider smoke test
+tanya doctor                  # local environment check
+```
+
+`--verify` adds required verification commands to the run context. Tanya must run and report each exact command before finishing the coding task.
+
+`tanya benchmark run --all` currently exercises 26 executable low-to-medium regression fixtures: targeted edits, new files, dependency/lockfile updates, framework-style migrations, failing-test repair, frontend smoke checks, artifact/context reuse, streaming long-tool execution, run-history logging, dirty worktrees, report repair, and the CosmoHQ mobile/backend smoke profiles.
+
+By default, `tanya run` also performs an independent post-check after the agent finishes. If the workspace has a `typecheck` script, Tanya reruns that exact script with the local package manager (`npm`, `pnpm`, `yarn`, or `bun`). If not, it falls back to `npx tsc --noEmit --pretty false` when a `tsconfig` is present. If the workspace has a `test` script, Tanya reruns that as well unless the run already reported a passing test verification.
+
+By default, `tanya run` builds a generic task brief from local instructions, contracts, artifact indexes, project shape, and package scripts. Coding-shaped tasks get verification/report expectations automatically. If reusable artifact candidates are found, Tanya must read a relevant artifact or create a reusable one before changing code.
+
+Per-project persistent instructions can be stored in `.tania/INSTRUCTIONS.md`. Tanya injects this file into the system prompt for runs started inside that workspace. Create a starter file with:
+
+```bash
+tanya init
+tanya init --cwd /path/to/project
+```
+
+## Tool Visibility
+
+Human mode shows tools as they run:
+
+```text
+> search
+  input: {"query":"describe("}
+  ok: Found 3 match lines.
+```
+
+JSON mode emits machine-readable events:
+
+```json
+{"type":"tool_call","id":"call_1","tool":"search","input":{"query":"describe("}}
+{"type":"tool_result","id":"call_1","tool":"search","ok":true,"summary":"Found 3 match lines."}
+```
+
+## Streaming tool execution
+
+Long-running `run_shell` calls stream throttled stdout/stderr chunks to the active event sink while the model only receives the final `tool_result`.
+
+```text
+tanya run "Run npm test"  # emits tool_progress while the command runs; Ctrl-C cancels the active shell and returns partial_output
+```
+
+Context files are generic JSON envelopes for caller-supplied task metadata, artifacts, instructions, and verification commands.
+
+## Current Tools
+
+- `list_files`
+- `read_file`
+- `search`
+- `inspect_project_context`
+- `find_reusable_artifacts`
+- `build_task_brief`
+- `search_obsidian_notes`
+- `write_file`
+- `apply_patch`
+- `search_replace`
+- `copy_file`
+- `copy_dir`
+- `apply_artifact`
+- `create_ios_splash`
+- `create_android_splash`
+- `generate_app_icons`
+- `create_android_foundation`
+- `commit_platform_changes`
+- `resize_image`
+- `render_svg_to_png`
+- `create_apple_app_icon_set`
+- `create_android_launcher_icon_set`
+- `validate_apple_app_icon_set`
+- `validate_android_launcher_icon_set`
+- `validate_api_contract_routes`
+- `validate_android_project_config`
+- `validate_apple_project_files`
+- `validate_fastlane_config`
+- `validate_prisma_schema`
+- `scan_secrets`
+- `generate_video_asset`
+- `run_command`
+- `run_shell`
+
+All file paths are constrained to the selected workspace.
+
+## Video Assets
+
+Tanya can generate short compositable video assets locally with headless Chrome and ffmpeg:
+
+```bash
+tanya video one-terminal-simctl --output-dir assets/video --basename simctl-fail
+```
+
+The `one-terminal-simctl` preset recreates the native 980x1012, 30fps, 3s transparent Terminal asset with failing `xcrun simctl` commands. `terminal-simctl` is kept as an alias.
+
+To make variants, override terminal copy with repeated `--line` flags:
+
+```bash
+tanya video one-terminal-simctl \
+  --output-dir assets/video \
+  --basename install-failure \
+  --line '$ xcrun simctl install booted CosmoKit.app' \
+  --line 'error: unable to find a booted simulator' \
+  --line '$ xcrun simctl io booted screenshot out.png' \
+  --line 'xcrun: error: selected device is not available'
+```
+
+Outputs default to WebM VP9 alpha, ProRes 4444 MOV alpha, and a transparent poster PNG. Chrome/Chromium and ffmpeg must be installed; set `TANYA_CHROME_PATH` or `TANYA_FFMPEG_PATH` if Tanya cannot find them.