kunji 0.1.0__tar.gz

kunji-0.1.0/.gitignore

@@ -0,0 +1,27 @@
+# Python
+__pycache__/
+*.py[cod]
+*.egg-info/
+.venv/
+venv/
+build/
+dist/
+*.spec.bak
+.pytest_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+
+# Editors / OS
+.vscode/
+.idea/
+.DS_Store
+Thumbs.db
+
+# Secrets — never commit these
+.env
+.env.*
+*.pem
+*.key
+secrets/
+kunji-chat-*.md

kunji-0.1.0/CHANGELOG.md

@@ -0,0 +1,37 @@
+# Changelog
+
+All notable changes are listed here. The format follows
+[Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and the project uses
+[semantic versioning](https://semver.org/).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-11-02
+
+### Added
+- Interactive chat with streaming markdown answers, slash commands and history.
+- Providers: OpenAI, Anthropic, Gemini, Groq, OpenRouter, DeepSeek, Mistral, xAI, Together,
+  Ollama, and custom OpenAI-compatible servers.
+- `/model` switching mid-conversation with tab completion.
+- API keys in the OS keychain (or environment variables), verified before saving.
+- Live cost meter, `kunji usage`, and daily budgets (warn at 80%, block at 100%).
+- `kunji compare` — one prompt, several models, with fastest/cheapest summary.
+- Automatic fallback to the next model on rate limits or outages.
+- `kunji ask` with pipe support and `--raw` output for scripts.
+- `kunji doctor`, `kunji models`, `kunji providers`, `kunji config`.
+- Responsive, minimal theme that adapts to any terminal width.
+- Update notice via PyPI and signed (Ed25519) cloud check-in client (off until a server URL
+  is configured).
+
+### Build
+- Standalone downloads for Windows (`kunji-windows-x64.exe`) and Linux; macOS users install
+  with `pipx install kunji` (a macOS download can be switched on later).
+- Releases run automatically when the version number changes, with notes taken from this
+  changelog.
+
+### Design
+- Compact one-row summary tables (`Strip`) for the chat header, `/cost`, `keys add`,
+  `usage` totals and `version` — 5 lines instead of ~11, more room for the conversation.
+- `kunji compare` summary is now a table: time, tokens, cost and fastest/cheapest badges
+  for every model.
+- README badges restyled for readability on light and dark GitHub themes.

kunji-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 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 [yyyy] [name of copyright owner]
+
+   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.

kunji-0.1.0/PKG-INFO

@@ -0,0 +1,207 @@
+Metadata-Version: 2.5
+Name: kunji
+Version: 0.1.0
+Summary: Bring your own key. Every AI model in one clean, professional terminal.
+Project-URL: Homepage, https://github.com/testwithsuraj/kunji
+Project-URL: Issues, https://github.com/testwithsuraj/kunji/issues
+Project-URL: Changelog, https://github.com/testwithsuraj/kunji/blob/main/CHANGELOG.md
+Author: Kunji contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: ai,anthropic,byok,cli,gemini,llm,ollama,openai,terminal
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: cryptography>=42
+Requires-Dist: httpx>=0.27
+Requires-Dist: keyring>=25
+Requires-Dist: platformdirs>=4
+Requires-Dist: prompt-toolkit>=3.0.43
+Requires-Dist: questionary>=2.0
+Requires-Dist: rich>=13.7
+Requires-Dist: tomli-w>=1.0
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: pyinstaller>=6; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Description-Content-Type: text/markdown
+
+<div align="center">
+
+# kunji
+
+**Bring your own key. Every AI model in one clean, professional terminal.**
+
+*Kunji (कुंजी) means "key" in Hindi.*
+
+[![CI](https://img.shields.io/github/actions/workflow/status/testwithsuraj/kunji/ci.yml?branch=main&style=flat-square&label=CI&labelColor=1f2328)](https://github.com/testwithsuraj/kunji/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-3ddc84?style=flat-square&labelColor=1f2328)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%2B-3ddc84?style=flat-square&labelColor=1f2328&logo=python&logoColor=white)](https://www.python.org/downloads/)
+[![Providers](https://img.shields.io/badge/providers-10%2B-3ddc84?style=flat-square&labelColor=1f2328)](#providers)
+[![Platforms](https://img.shields.io/badge/windows%20%7C%20macos%20%7C%20linux-3ddc84?style=flat-square&labelColor=1f2328&label=runs%20on)](#install)
+
+</div>
+
+```
+┌─  kunji chat  ─────────────────────────────────────────────────┐
+│  Provider     Model            Key         Budget        State │
+│────────────────────────────────────────────────────────────────│
+│  Anthropic    claude-sonnet    keychain    $0.38 / $2    READY │
+└────────────────────────────────────────────────────────────────┘
+enter send  ·  alt+enter newline  ·  / commands  ·  ctrl+d quit
+
+› explain recursion in one line
+  A function that solves a problem by calling itself on a smaller
+  piece of it, until it reaches a case simple enough to answer.
+  claude-sonnet · 18 in · 31 out · $0.0005 · 1.2s
+
+› /model groq:llama-3.3-70b-versatile
+✓ Switched to groq:llama-3.3-70b-versatile  conversation kept
+```
+
+Kunji is a terminal app for chatting with any AI model using **your own API keys**.
+You pay each provider directly. Kunji never sees your bill, your keys or your prompts.
+
+## Why kunji
+
+- **One tool, every provider.** OpenAI, Anthropic, Google Gemini, Groq, OpenRouter,
+  DeepSeek, Mistral, xAI, Together, Ollama (local), plus any OpenAI-compatible server.
+- **Switch models mid-conversation** with `/model` — the conversation carries over.
+- **Live cost meter.** Every reply shows tokens and cost. `/cost` and `kunji usage`
+  show totals, in your currency.
+- **Daily budgets.** Warns at 80%, blocks at 100%, per provider or overall.
+- **Compare mode.** One prompt, several models, side by side — fastest and cheapest highlighted.
+- **Automatic fallback.** Rate-limited or down? Kunji retries on your next model.
+- **Keys in your OS keychain** (Windows Credential Manager, macOS Keychain, Secret Service),
+  never in a plain-text file.
+- **Pipes.** `npm test 2>&1 | kunji ask "why is this failing?"`
+- **Looks professional.** Minimal monochrome design, responsive to any terminal size.
+
+## Install
+
+Requires Python 3.11+.
+
+```bash
+pipx install kunji        # recommended
+# or
+uv tool install kunji
+# or
+python -m pip install --user kunji
+```
+
+| System | Easiest way |
+| --- | --- |
+| Windows | `pipx install kunji`, or download `kunji-windows-x64.exe` from the [latest release](https://github.com/testwithsuraj/kunji/releases/latest) (no Python needed) |
+| macOS | `pipx install kunji` |
+| Linux | `pipx install kunji`, or download `kunji-linux-x64` from the latest release |
+
+`winget`, Scoop and Homebrew packages are on the [roadmap](ROADMAP.md).
+
+## Quick start
+
+```bash
+kunji keys add            # pick a provider, paste your key, choose a default model
+kunji                     # start chatting
+```
+
+Free and local? Install [Ollama](https://ollama.com), then `kunji keys add ollama`.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `kunji` / `kunji chat` | Interactive chat (`-m provider:model`, `-s "system prompt"`) |
+| `kunji ask "…"` | One-shot answer. Reads piped input. `--raw` for scripts |
+| `kunji compare "…" -m a -m b` | Same prompt to several models, side by side |
+| `kunji keys add [provider]` | Add or replace a key (verified, then saved to the keychain) |
+| `kunji keys list` / `test` / `remove` | Manage keys (always masked) |
+| `kunji models [provider]` | Live model list with prices |
+| `kunji use provider:model` | Set your default model |
+| `kunji providers` | Supported providers; `providers add` for custom servers |
+| `kunji usage` | Tokens and cost per model (stored locally only) |
+| `kunji budget set <provider\|all> <amount>` | Daily spending limit |
+| `kunji config show` / `set` / `path` | Settings |
+| `kunji doctor` | Check Python, config, keychain and providers |
+
+### In chat
+
+| Input | Action |
+| --- | --- |
+| `/model provider:model` | Switch model (tab completes) |
+| `/models [filter]` | List models of the current provider |
+| `/cost` | Session and today's cost |
+| `/system …` | Set the system prompt |
+| `/retry` · `/clear` · `/save [file]` | Regenerate · new conversation · export markdown |
+| `enter` · `alt+enter` / `ctrl+j` | Send · new line |
+| `ctrl+c` · `ctrl+d` | Stop the reply · quit |
+
+## Providers
+
+| ID | Provider | Key env variable |
+| --- | --- | --- |
+| `openai` | OpenAI | `OPENAI_API_KEY` |
+| `anthropic` | Anthropic | `ANTHROPIC_API_KEY` |
+| `gemini` | Google Gemini | `GEMINI_API_KEY` / `GOOGLE_API_KEY` |
+| `groq` | Groq | `GROQ_API_KEY` |
+| `openrouter` | OpenRouter | `OPENROUTER_API_KEY` |
+| `deepseek` | DeepSeek | `DEEPSEEK_API_KEY` |
+| `mistral` | Mistral | `MISTRAL_API_KEY` |
+| `xai` | xAI | `XAI_API_KEY` |
+| `together` | Together AI | `TOGETHER_API_KEY` |
+| `ollama` | Ollama (local) | none |
+
+Any OpenAI-compatible server (LM Studio, vLLM, LiteLLM proxy…):
+
+```bash
+kunji providers add lmstudio --base-url http://localhost:1234/v1 --no-key
+```
+
+## Security and privacy
+
+- API keys are stored **only** in your operating system's credential store, or read from
+  environment variables. They are sent **only** to the provider they belong to.
+- Kunji's config file never contains keys. Errors are scrubbed so keys never appear on screen.
+- Usage and cost history stay on your machine (`kunji config path`).
+- Network calls kunji makes on its own: the public model price list (OpenRouter, plus this
+  repo's `catalog/pricing.json`) and the PyPI version check. Neither sends anything about you.
+  Turn them off with `kunji config set network.catalog false` and
+  `kunji config set updates.check false`.
+- Found a vulnerability? Please follow [SECURITY.md](SECURITY.md).
+
+Details: [docs/PRIVACY.md](docs/PRIVACY.md).
+
+## Configuration
+
+```bash
+kunji config set display.currency INR
+kunji config set display.usd_rate 84          # your conversion rate
+kunji budget set all 200                      # ₹200/day across every provider
+kunji config set fallback '["groq:llama-3.3-70b-versatile", "ollama:qwen2.5"]'
+```
+
+All options: [docs/CONFIG.md](docs/CONFIG.md).
+
+## Free and Pro
+
+Everything that runs on your machine is **free and open source, forever** — chat,
+switching, keys, cost meter, budgets, compare, fallback, pipes. A future optional
+**Pro** plan will add cloud features that need a server (sync across devices, shared team
+keys with per-person budgets, a smart router). See [ROADMAP.md](ROADMAP.md).
+
+## Contributing
+
+Bug reports, ideas and pull requests are welcome — start with
+[CONTRIBUTING.md](CONTRIBUTING.md). Architecture overview: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md).
+
+## License
+
+[Apache-2.0](LICENSE). "kunji" and the kunji logo are not covered by the license; please
+use a different name for forks.

kunji-0.1.0/README.md

@@ -0,0 +1,171 @@
+<div align="center">
+
+# kunji
+
+**Bring your own key. Every AI model in one clean, professional terminal.**
+
+*Kunji (कुंजी) means "key" in Hindi.*
+
+[![CI](https://img.shields.io/github/actions/workflow/status/testwithsuraj/kunji/ci.yml?branch=main&style=flat-square&label=CI&labelColor=1f2328)](https://github.com/testwithsuraj/kunji/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-3ddc84?style=flat-square&labelColor=1f2328)](LICENSE)
+[![Python](https://img.shields.io/badge/python-3.11%2B-3ddc84?style=flat-square&labelColor=1f2328&logo=python&logoColor=white)](https://www.python.org/downloads/)
+[![Providers](https://img.shields.io/badge/providers-10%2B-3ddc84?style=flat-square&labelColor=1f2328)](#providers)
+[![Platforms](https://img.shields.io/badge/windows%20%7C%20macos%20%7C%20linux-3ddc84?style=flat-square&labelColor=1f2328&label=runs%20on)](#install)
+
+</div>
+
+```
+┌─  kunji chat  ─────────────────────────────────────────────────┐
+│  Provider     Model            Key         Budget        State │
+│────────────────────────────────────────────────────────────────│
+│  Anthropic    claude-sonnet    keychain    $0.38 / $2    READY │
+└────────────────────────────────────────────────────────────────┘
+enter send  ·  alt+enter newline  ·  / commands  ·  ctrl+d quit
+
+› explain recursion in one line
+  A function that solves a problem by calling itself on a smaller
+  piece of it, until it reaches a case simple enough to answer.
+  claude-sonnet · 18 in · 31 out · $0.0005 · 1.2s
+
+› /model groq:llama-3.3-70b-versatile
+✓ Switched to groq:llama-3.3-70b-versatile  conversation kept
+```
+
+Kunji is a terminal app for chatting with any AI model using **your own API keys**.
+You pay each provider directly. Kunji never sees your bill, your keys or your prompts.
+
+## Why kunji
+
+- **One tool, every provider.** OpenAI, Anthropic, Google Gemini, Groq, OpenRouter,
+  DeepSeek, Mistral, xAI, Together, Ollama (local), plus any OpenAI-compatible server.
+- **Switch models mid-conversation** with `/model` — the conversation carries over.
+- **Live cost meter.** Every reply shows tokens and cost. `/cost` and `kunji usage`
+  show totals, in your currency.
+- **Daily budgets.** Warns at 80%, blocks at 100%, per provider or overall.
+- **Compare mode.** One prompt, several models, side by side — fastest and cheapest highlighted.
+- **Automatic fallback.** Rate-limited or down? Kunji retries on your next model.
+- **Keys in your OS keychain** (Windows Credential Manager, macOS Keychain, Secret Service),
+  never in a plain-text file.
+- **Pipes.** `npm test 2>&1 | kunji ask "why is this failing?"`
+- **Looks professional.** Minimal monochrome design, responsive to any terminal size.
+
+## Install
+
+Requires Python 3.11+.
+
+```bash
+pipx install kunji        # recommended
+# or
+uv tool install kunji
+# or
+python -m pip install --user kunji
+```
+
+| System | Easiest way |
+| --- | --- |
+| Windows | `pipx install kunji`, or download `kunji-windows-x64.exe` from the [latest release](https://github.com/testwithsuraj/kunji/releases/latest) (no Python needed) |
+| macOS | `pipx install kunji` |
+| Linux | `pipx install kunji`, or download `kunji-linux-x64` from the latest release |
+
+`winget`, Scoop and Homebrew packages are on the [roadmap](ROADMAP.md).
+
+## Quick start
+
+```bash
+kunji keys add            # pick a provider, paste your key, choose a default model
+kunji                     # start chatting
+```
+
+Free and local? Install [Ollama](https://ollama.com), then `kunji keys add ollama`.
+
+## Commands
+
+| Command | What it does |
+| --- | --- |
+| `kunji` / `kunji chat` | Interactive chat (`-m provider:model`, `-s "system prompt"`) |
+| `kunji ask "…"` | One-shot answer. Reads piped input. `--raw` for scripts |
+| `kunji compare "…" -m a -m b` | Same prompt to several models, side by side |
+| `kunji keys add [provider]` | Add or replace a key (verified, then saved to the keychain) |
+| `kunji keys list` / `test` / `remove` | Manage keys (always masked) |
+| `kunji models [provider]` | Live model list with prices |
+| `kunji use provider:model` | Set your default model |
+| `kunji providers` | Supported providers; `providers add` for custom servers |
+| `kunji usage` | Tokens and cost per model (stored locally only) |
+| `kunji budget set <provider\|all> <amount>` | Daily spending limit |
+| `kunji config show` / `set` / `path` | Settings |
+| `kunji doctor` | Check Python, config, keychain and providers |
+
+### In chat
+
+| Input | Action |
+| --- | --- |
+| `/model provider:model` | Switch model (tab completes) |
+| `/models [filter]` | List models of the current provider |
+| `/cost` | Session and today's cost |
+| `/system …` | Set the system prompt |
+| `/retry` · `/clear` · `/save [file]` | Regenerate · new conversation · export markdown |
+| `enter` · `alt+enter` / `ctrl+j` | Send · new line |
+| `ctrl+c` · `ctrl+d` | Stop the reply · quit |
+
+## Providers
+
+| ID | Provider | Key env variable |
+| --- | --- | --- |
+| `openai` | OpenAI | `OPENAI_API_KEY` |
+| `anthropic` | Anthropic | `ANTHROPIC_API_KEY` |
+| `gemini` | Google Gemini | `GEMINI_API_KEY` / `GOOGLE_API_KEY` |
+| `groq` | Groq | `GROQ_API_KEY` |
+| `openrouter` | OpenRouter | `OPENROUTER_API_KEY` |
+| `deepseek` | DeepSeek | `DEEPSEEK_API_KEY` |
+| `mistral` | Mistral | `MISTRAL_API_KEY` |
+| `xai` | xAI | `XAI_API_KEY` |
+| `together` | Together AI | `TOGETHER_API_KEY` |
+| `ollama` | Ollama (local) | none |
+
+Any OpenAI-compatible server (LM Studio, vLLM, LiteLLM proxy…):
+
+```bash
+kunji providers add lmstudio --base-url http://localhost:1234/v1 --no-key
+```
+
+## Security and privacy
+
+- API keys are stored **only** in your operating system's credential store, or read from
+  environment variables. They are sent **only** to the provider they belong to.
+- Kunji's config file never contains keys. Errors are scrubbed so keys never appear on screen.
+- Usage and cost history stay on your machine (`kunji config path`).
+- Network calls kunji makes on its own: the public model price list (OpenRouter, plus this
+  repo's `catalog/pricing.json`) and the PyPI version check. Neither sends anything about you.
+  Turn them off with `kunji config set network.catalog false` and
+  `kunji config set updates.check false`.
+- Found a vulnerability? Please follow [SECURITY.md](SECURITY.md).
+
+Details: [docs/PRIVACY.md](docs/PRIVACY.md).
+
+## Configuration
+
+```bash
+kunji config set display.currency INR
+kunji config set display.usd_rate 84          # your conversion rate
+kunji budget set all 200                      # ₹200/day across every provider
+kunji config set fallback '["groq:llama-3.3-70b-versatile", "ollama:qwen2.5"]'
+```
+
+All options: [docs/CONFIG.md](docs/CONFIG.md).
+
+## Free and Pro
+
+Everything that runs on your machine is **free and open source, forever** — chat,
+switching, keys, cost meter, budgets, compare, fallback, pipes. A future optional
+**Pro** plan will add cloud features that need a server (sync across devices, shared team
+keys with per-person budgets, a smart router). See [ROADMAP.md](ROADMAP.md).
+
+## Contributing
+
+Bug reports, ideas and pull requests are welcome — start with
+[CONTRIBUTING.md](CONTRIBUTING.md). Architecture overview: [docs/ARCHITECTURE.md](docs/ARCHITECTURE.md).
+
+## License
+
+[Apache-2.0](LICENSE). "kunji" and the kunji logo are not covered by the license; please
+use a different name for forks.

kunji-0.1.0/packaging/README.md

@@ -0,0 +1,33 @@
+# Packaging
+
+| Channel | How | Users install with |
+| --- | --- | --- |
+| PyPI | Automatic: `.github/workflows/release.yml` on a `v*` tag | `pipx install kunji` |
+| GitHub Releases | Automatic: Windows + Linux binaries + `SHA256SUMS.txt` (macOS: set repo variable `BUILD_MACOS=true`) | download |
+| winget | `wingetcreate` with the release `.exe` (see `winget/`) | `winget install testwithsuraj.kunji` |
+| Scoop | Copy `scoop/kunji.json` into a `scoop-bucket` repo | `scoop bucket add kunji https://github.com/testwithsuraj/scoop-bucket` then `scoop install kunji` |
+| Homebrew | Copy `homebrew/kunji.rb` into a `homebrew-tap` repo | `brew install testwithsuraj/tap/kunji` |
+
+Build a binary locally:
+
+```bash
+python -m pip install -e ".[dev]"
+pyinstaller packaging/kunji.spec --noconfirm --clean
+./dist/kunji --version
+```
+
+## Releasing a new version
+
+1. Set the new version in `src/kunji/__init__.py` (e.g. `__version__ = "0.2.0"`).
+2. Add `## [0.2.0] - YYYY-MM-DD` to `CHANGELOG.md` — that section becomes the release notes.
+3. Commit and push to `main`.
+4. GitHub → Actions → **Release** → **Review deployments** → `pypi` → **Approve and deploy**.
+
+The workflow then publishes to PyPI, creates the `v0.2.0` tag and the GitHub Release with
+the downloads. Pushing to `main` without changing the version never releases anything.
+
+### Turning on the macOS download later
+
+GitHub → Settings → Secrets and variables → Actions → **Variables** → New repository
+variable: `BUILD_MACOS` = `true`. Nothing else to change; if a Mac build ever fails, the
+release still goes out without it.