convo-cli 0.1.0__tar.gz

convo_cli-0.1.0/.gitignore

@@ -0,0 +1,9 @@
+.venv/
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.env
+dist/
+*.egg-info/
+screenshots/

convo_cli-0.1.0/CODE_OF_CONDUCT.md

@@ -0,0 +1,5 @@
+# Code of Conduct
+
+We want Convo to be a welcoming project for contributors of every background and experience level. Be respectful, constructive, and considerate in issues, pull requests, and discussions.
+
+Harassment, discrimination, personal attacks, and sharing another person's private information are not acceptable. Report concerns privately to the repository maintainers. Maintainers may remove content or restrict participation when behaviour violates this standard.

convo_cli-0.1.0/CONTRIBUTING.md

@@ -0,0 +1,26 @@
+# Contributing to Convo
+
+Contributions from students, researchers, and terminal-tool enthusiasts are welcome.
+
+## Before opening a pull request
+
+1. Fork the repository and create a focused branch.
+2. Install the project with `uv sync --python 3.12`.
+3. Keep changes focused: do not mix formatting, dependency upgrades, and unrelated features.
+4. Add or update tests for changed behaviour.
+5. Run the checks below from the repository root.
+
+```sh
+uv run ruff format --check .
+uv run ruff check .
+uv run ty check
+uv run pytest -q
+```
+
+PostgreSQL and model checks are intentionally opt-in; see `ARCHITECTURE.md` for the required environment variables. Never commit `.env`, tokens, personal documents, model caches, or database dumps.
+
+## Pull requests
+
+Explain the user-visible change, the design trade-off, and verification performed. Keep UI code independent of database and model implementation details. If you change the data model, include a reviewed Alembic migration and explain how existing local data is preserved.
+
+By contributing, you agree that your contribution is licensed under the repository's MIT License.

convo_cli-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Mohit Sharma
+
+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.

convo_cli-0.1.0/PKG-INFO

@@ -0,0 +1,160 @@
+Metadata-Version: 2.5
+Name: convo-cli
+Version: 0.1.0
+Summary: A local terminal RAG assistant for chatting with selected files.
+Project-URL: Homepage, https://github.com/madvillax/convo
+Project-URL: Repository, https://github.com/madvillax/convo
+Project-URL: Issues, https://github.com/madvillax/convo/issues
+Author: Mohit Sharma
+License-Expression: MIT
+License-File: LICENSE
+Keywords: cli,local-first,rag,terminal,textual
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Text Processing :: General
+Requires-Python: >=3.11
+Requires-Dist: alembic>=1.20.0
+Requires-Dist: docx2txt>=0.9
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: keyring>=25.6
+Requires-Dist: llama-index-core>=0.14.25
+Requires-Dist: llama-index-readers-file>=0.7.0
+Requires-Dist: numpy>=2.4.6
+Requires-Dist: openai>=2.0
+Requires-Dist: pgvector>=0.5.1
+Requires-Dist: psycopg[binary]>=3
+Requires-Dist: pydantic<3,>=2.0
+Requires-Dist: pyjwt[crypto]>=2.10
+Requires-Dist: python-dotenv>=1.2.4
+Requires-Dist: sentence-transformers>=6.1.0
+Requires-Dist: sqlalchemy<3,>=2.0
+Requires-Dist: textual<9,>=8.2
+Requires-Dist: transformers>=4.51
+Description-Content-Type: text/markdown
+
+# Convo
+
+Convo is an open-source, local-first terminal app for chatting with a selected file. Qwen3 embeddings and PostgreSQL full-text search retrieve passages together; a local cross-encoder reranks them; your connected ChatGPT account returns a structured answer with supporting quotations.
+
+It is released under the [MIT License](LICENSE). Contributions are welcome—see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Install and start
+
+The supported release install uses [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install convo-cli
+convo
+```
+
+On first launch, `convo` creates a private settings file at `~/.config/convo/.env`, pulls `pgvector/pgvector:pg16`, starts a loopback-only `convo-postgres` container, and runs migrations before opening the terminal app. It generates a random database password and preserves existing data. Later launches restart Convo's local container if needed and apply pending migrations.
+
+Local storage needs Docker Desktop or Podman installed. Start Docker Desktop first if you use Docker. On macOS, Convo starts or initializes a Podman machine when Podman is installed. First use downloads Python dependencies, a database image, and—when indexing your first file—the embedding/reranker models.
+
+If you already use PostgreSQL, set `DATABASE_URL` to a `postgresql+psycopg://...` URL, run `convo --setup` once to migrate that database, then run `convo`. Explicit database connections are used as configured; startup only manages storage created by Convo.
+
+For a one-command install on macOS/Linux, inspect and then run the repository installer:
+
+```sh
+curl -LsSf https://raw.githubusercontent.com/madvillax/convo/main/scripts/install.sh | sh
+```
+
+It installs uv if needed, installs `convo-cli`, and adds uv's tool directory to your shell path. Then type `convo` to start. Open a new terminal if `convo` is not immediately found.
+
+To use an unreleased checkout while developing:
+
+```sh
+uv sync --python 3.12
+uv run convo
+```
+
+`--directory ~/Documents` changes the file browser root. Environment variables always override the user settings file; `.env.example` is only for checkout-based development.
+
+Optional model download/warmup outside the TUI:
+
+```sh
+uv run convo --download-model
+```
+
+This prepares both Qwen3 and `cross-encoder/ms-marco-MiniLM-L6-v2`. Models otherwise load/download on demand in an isolated process. File preparation shows stages and elapsed time; Esc cancels it. Download/native logs stay in `~/.cache/convo/rag-worker.log` (respecting `XDG_CACHE_HOME`). After storage preparation, startup restores account preferences locally; models and the account catalog load when needed.
+
+For a UI preview without services or backend dependencies:
+
+```sh
+uv run convo --shell
+```
+
+## Use
+
+Type `/` for command suggestions. Filter by typing, use ↑/↓ to move, Tab to complete, Enter to run, and Esc to dismiss.
+
+| Command/key | Action |
+| --- | --- |
+| `/login` | Connect your ChatGPT account through browser sign-in |
+| `/models` | Search and select an account model |
+| `/models <id>` | Select a model directly |
+| Ctrl+T or Shift+Tab | Cycle auto and the model's supported thinking levels |
+| F2 or `/thinking` | Choose a thinking level directly |
+| `/thinking high`, `/thinking auto` | Set a supported level or restore the model default |
+| `/file`, Ctrl+O | Select and index a file; create a saved conversation |
+| `/sessions` | Search saved conversations by title, filename, or ID and resume one |
+| `/sessions <uuid>` | Resume a conversation directly |
+| `/new` | Create a new saved conversation, keeping the selected file |
+| `/clear` | Same behavior as `/new`; previous conversations remain saved |
+| `/reset` | Create a new saved conversation without a selected file |
+| Esc during file preparation | Stop preparation and restore the input |
+| `/help` | Show commands and keys |
+| `/quit`, `/exit`, Ctrl+C | Exit |
+| PageUp / PageDown | Scroll the transcript while keeping the input focused |
+
+Questions appear in shaded blocks with a gold left edge. Answers use spaced Markdown with highlighted code, and source quotations appear in a separate subdued block. The composer groups your input with the gold model name and thinking level underneath. The ASCII title collapses once chatting starts and in smaller terminals, leaving more room to read. Long replies open at the question and the beginning of the answer; use PageUp/PageDown or the mouse wheel to keep reading.
+
+Change the cycling shortcut with `convo --thinking-key ctrl+g` or set `CONVO_THINKING_KEY=ctrl+g` in `.env` (export it for `--shell`). The command-line flag takes precedence. Shift+Tab and F2 remain available. Choose a Ctrl/Alt letter or F3–F24; essential keys are reserved. `/help` shows the configured shortcut. Only thinking levels supported by the selected account model can be saved.
+
+Sessions, completed message pairs, displayed source quotes, and structured answers persist in PostgreSQL. Use `/sessions` after restarting. Resuming uses the saved indexed snapshot, so the original file can have moved or disappeared. Use `/file` again to index changed content. A failed request never saves a partial turn. Account tokens remain in the OS keyring; model/thinking preferences remain in the local account profile.
+
+Greetings such as `hello` and acknowledgements such as `thank you` receive a short local reply without retrieval or model calls. Mixed greetings and file questions still use retrieval. Specific questions use hybrid search, reciprocal rank fusion, cross-encoder reranking, and weak-match filtering. Broad file overviews sample sections across the snapshot and rerank their order without applying a QA relevance cutoff.
+
+ChatGPT returns JSON sections containing text and citation objects. Python validates the schema, requires citations on answered sections, checks source IDs and exact supporting quotes, then renders readable Markdown with numbered citations. Only cited quotes appear under sources. An empty evidence set returns an insufficient-evidence response without an LLM call. These checks verify structure and quotations; they do not prove every generated claim is entailed by its quote.
+
+Supported files: `.txt`, `.md`, `.pdf`, `.docx`, `.csv`, `.json`, `.py`, `.rst`, `.log`. Limits: 10 MB input, 500,000 extracted characters, and 2,000 chunks. LlamaIndex is used only for readers and chunking. The TUI supports terminals down to 50 columns × 18 rows.
+
+## Architecture
+
+```text
+convo/
+├── core/       settings, shared values and UI/backend contracts
+├── ui/         Textual app, commands, file/model/session pickers
+├── llm/        ChatGPT connection, credentials, catalog and Responses transport
+├── pipeline/   chat flow, routing, ingestion, embeddings, reranking and worker
+├── prompts/    answer instructions, context builder and structured schema
+└── db/         SQLAlchemy models, connections, document/search/session queries
+```
+
+[ARCHITECTURE.md](ARCHITECTURE.md) explains the files, schema, data flow, tuning, and verification. [changes.md](changes.md) records implementation approaches and validation.
+
+## Checks
+
+```sh
+uv run ruff format --check .
+uv run ruff check .
+uv run ty check
+uv run pytest -q
+```
+
+PostgreSQL integration checks use a disposable database, enabled explicitly with `CONVO_TEST_DATABASE_URL`. `CONVO_TEST_MODELS=1` also exercises real Qwen/reranking models. See [ARCHITECTURE.md](ARCHITECTURE.md) for these opt-in checks and their prerequisites.
+
+## Releasing to PyPI
+
+Maintainers should test a release on TestPyPI first, then create a GitHub release. The included `Publish to PyPI` workflow uses PyPI Trusted Publishing, so it does not require a long-lived token in the repository. Configure the repository and `.github/workflows/publish.yml` as a Trusted Publisher in PyPI before publishing.
+
+```sh
+uv build --no-sources
+uv publish --token "$PYPI_TOKEN" # one-time/manual alternative
+```

convo_cli-0.1.0/README.md

@@ -0,0 +1,120 @@
+# Convo
+
+Convo is an open-source, local-first terminal app for chatting with a selected file. Qwen3 embeddings and PostgreSQL full-text search retrieve passages together; a local cross-encoder reranks them; your connected ChatGPT account returns a structured answer with supporting quotations.
+
+It is released under the [MIT License](LICENSE). Contributions are welcome—see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Install and start
+
+The supported release install uses [uv](https://docs.astral.sh/uv/):
+
+```sh
+uv tool install convo-cli
+convo
+```
+
+On first launch, `convo` creates a private settings file at `~/.config/convo/.env`, pulls `pgvector/pgvector:pg16`, starts a loopback-only `convo-postgres` container, and runs migrations before opening the terminal app. It generates a random database password and preserves existing data. Later launches restart Convo's local container if needed and apply pending migrations.
+
+Local storage needs Docker Desktop or Podman installed. Start Docker Desktop first if you use Docker. On macOS, Convo starts or initializes a Podman machine when Podman is installed. First use downloads Python dependencies, a database image, and—when indexing your first file—the embedding/reranker models.
+
+If you already use PostgreSQL, set `DATABASE_URL` to a `postgresql+psycopg://...` URL, run `convo --setup` once to migrate that database, then run `convo`. Explicit database connections are used as configured; startup only manages storage created by Convo.
+
+For a one-command install on macOS/Linux, inspect and then run the repository installer:
+
+```sh
+curl -LsSf https://raw.githubusercontent.com/madvillax/convo/main/scripts/install.sh | sh
+```
+
+It installs uv if needed, installs `convo-cli`, and adds uv's tool directory to your shell path. Then type `convo` to start. Open a new terminal if `convo` is not immediately found.
+
+To use an unreleased checkout while developing:
+
+```sh
+uv sync --python 3.12
+uv run convo
+```
+
+`--directory ~/Documents` changes the file browser root. Environment variables always override the user settings file; `.env.example` is only for checkout-based development.
+
+Optional model download/warmup outside the TUI:
+
+```sh
+uv run convo --download-model
+```
+
+This prepares both Qwen3 and `cross-encoder/ms-marco-MiniLM-L6-v2`. Models otherwise load/download on demand in an isolated process. File preparation shows stages and elapsed time; Esc cancels it. Download/native logs stay in `~/.cache/convo/rag-worker.log` (respecting `XDG_CACHE_HOME`). After storage preparation, startup restores account preferences locally; models and the account catalog load when needed.
+
+For a UI preview without services or backend dependencies:
+
+```sh
+uv run convo --shell
+```
+
+## Use
+
+Type `/` for command suggestions. Filter by typing, use ↑/↓ to move, Tab to complete, Enter to run, and Esc to dismiss.
+
+| Command/key | Action |
+| --- | --- |
+| `/login` | Connect your ChatGPT account through browser sign-in |
+| `/models` | Search and select an account model |
+| `/models <id>` | Select a model directly |
+| Ctrl+T or Shift+Tab | Cycle auto and the model's supported thinking levels |
+| F2 or `/thinking` | Choose a thinking level directly |
+| `/thinking high`, `/thinking auto` | Set a supported level or restore the model default |
+| `/file`, Ctrl+O | Select and index a file; create a saved conversation |
+| `/sessions` | Search saved conversations by title, filename, or ID and resume one |
+| `/sessions <uuid>` | Resume a conversation directly |
+| `/new` | Create a new saved conversation, keeping the selected file |
+| `/clear` | Same behavior as `/new`; previous conversations remain saved |
+| `/reset` | Create a new saved conversation without a selected file |
+| Esc during file preparation | Stop preparation and restore the input |
+| `/help` | Show commands and keys |
+| `/quit`, `/exit`, Ctrl+C | Exit |
+| PageUp / PageDown | Scroll the transcript while keeping the input focused |
+
+Questions appear in shaded blocks with a gold left edge. Answers use spaced Markdown with highlighted code, and source quotations appear in a separate subdued block. The composer groups your input with the gold model name and thinking level underneath. The ASCII title collapses once chatting starts and in smaller terminals, leaving more room to read. Long replies open at the question and the beginning of the answer; use PageUp/PageDown or the mouse wheel to keep reading.
+
+Change the cycling shortcut with `convo --thinking-key ctrl+g` or set `CONVO_THINKING_KEY=ctrl+g` in `.env` (export it for `--shell`). The command-line flag takes precedence. Shift+Tab and F2 remain available. Choose a Ctrl/Alt letter or F3–F24; essential keys are reserved. `/help` shows the configured shortcut. Only thinking levels supported by the selected account model can be saved.
+
+Sessions, completed message pairs, displayed source quotes, and structured answers persist in PostgreSQL. Use `/sessions` after restarting. Resuming uses the saved indexed snapshot, so the original file can have moved or disappeared. Use `/file` again to index changed content. A failed request never saves a partial turn. Account tokens remain in the OS keyring; model/thinking preferences remain in the local account profile.
+
+Greetings such as `hello` and acknowledgements such as `thank you` receive a short local reply without retrieval or model calls. Mixed greetings and file questions still use retrieval. Specific questions use hybrid search, reciprocal rank fusion, cross-encoder reranking, and weak-match filtering. Broad file overviews sample sections across the snapshot and rerank their order without applying a QA relevance cutoff.
+
+ChatGPT returns JSON sections containing text and citation objects. Python validates the schema, requires citations on answered sections, checks source IDs and exact supporting quotes, then renders readable Markdown with numbered citations. Only cited quotes appear under sources. An empty evidence set returns an insufficient-evidence response without an LLM call. These checks verify structure and quotations; they do not prove every generated claim is entailed by its quote.
+
+Supported files: `.txt`, `.md`, `.pdf`, `.docx`, `.csv`, `.json`, `.py`, `.rst`, `.log`. Limits: 10 MB input, 500,000 extracted characters, and 2,000 chunks. LlamaIndex is used only for readers and chunking. The TUI supports terminals down to 50 columns × 18 rows.
+
+## Architecture
+
+```text
+convo/
+├── core/       settings, shared values and UI/backend contracts
+├── ui/         Textual app, commands, file/model/session pickers
+├── llm/        ChatGPT connection, credentials, catalog and Responses transport
+├── pipeline/   chat flow, routing, ingestion, embeddings, reranking and worker
+├── prompts/    answer instructions, context builder and structured schema
+└── db/         SQLAlchemy models, connections, document/search/session queries
+```
+
+[ARCHITECTURE.md](ARCHITECTURE.md) explains the files, schema, data flow, tuning, and verification. [changes.md](changes.md) records implementation approaches and validation.
+
+## Checks
+
+```sh
+uv run ruff format --check .
+uv run ruff check .
+uv run ty check
+uv run pytest -q
+```
+
+PostgreSQL integration checks use a disposable database, enabled explicitly with `CONVO_TEST_DATABASE_URL`. `CONVO_TEST_MODELS=1` also exercises real Qwen/reranking models. See [ARCHITECTURE.md](ARCHITECTURE.md) for these opt-in checks and their prerequisites.
+
+## Releasing to PyPI
+
+Maintainers should test a release on TestPyPI first, then create a GitHub release. The included `Publish to PyPI` workflow uses PyPI Trusted Publishing, so it does not require a long-lived token in the repository. Configure the repository and `.github/workflows/publish.yml` as a Trusted Publisher in PyPI before publishing.
+
+```sh
+uv build --no-sources
+uv publish --token "$PYPI_TOKEN" # one-time/manual alternative
+```

convo_cli-0.1.0/alembic.ini

@@ -0,0 +1,5 @@
+[alembic]
+script_location = %(here)s/migrations
+prepend_sys_path = .
+path_separator = os
+# The URL is supplied by core/config.py in migrations/env.py; never commit credentials.

convo_cli-0.1.0/convo/__init__.py

@@ -0,0 +1,3 @@
+"""A local terminal RAG assistant for chatting with selected files."""
+
+__version__ = "0.1.0"

convo_cli-0.1.0/convo/__main__.py

@@ -0,0 +1,110 @@
+import argparse
+import os
+from pathlib import Path
+
+from convo.ui.app import ConvoApp
+from convo.ui.preview import ShellBackend
+from convo.ui.thinking import thinking_key
+
+
+def main() -> None:
+    parser = argparse.ArgumentParser(description="Chat with a file in your current directory.")
+    parser.add_argument("--directory", type=Path, default=None, help="Browse this folder instead")
+    parser.add_argument(
+        "--thinking-key",
+        type=thinking_key,
+        default=None,
+        help="Thinking cycle shortcut (default: CONVO_THINKING_KEY or ctrl+t)",
+    )
+    mode = parser.add_mutually_exclusive_group()
+    mode.add_argument(
+        "--shell",
+        action="store_true",
+        help="Run the UI preview without PostgreSQL, embeddings, or ChatGPT",
+    )
+    mode.add_argument(
+        "--download-model",
+        action="store_true",
+        help="Download and warm Qwen3 and the reranker outside the TUI, then exit",
+    )
+    mode.add_argument(
+        "--setup",
+        action="store_true",
+        help="Create and migrate Convo's local PostgreSQL/pgvector storage, then exit",
+    )
+    args = parser.parse_args()
+    directory = (args.directory or Path.cwd()).expanduser().resolve()
+    if not directory.is_dir():
+        parser.error(f"Not a directory: {directory}")
+    if args.shell:
+        try:
+            app = ConvoApp(directory, ShellBackend(), thinking_shortcut=args.thinking_key)
+        except ValueError as error:
+            parser.error(str(error))
+        app.run()
+        return
+
+    try:
+        from convo.core.config import load_settings
+        from convo.pipeline.chat import RagBackend
+    except ImportError as error:
+        parser.error(
+            f"Backend dependency {error.name} is missing. Install the published command with "
+            "`uv tool install --force convo-cli`; from a checkout run `uv run convo`."
+        )
+
+    if args.setup:
+        from convo.bootstrap import SetupError, setup
+
+        try:
+            settings_path = setup()
+        except (SetupError, ValueError) as error:
+            parser.error(str(error))
+        print(f"Convo storage is ready. Settings are in {settings_path}. Run `convo` to start.")
+        return
+
+    if args.download_model:
+        # Warming models does not require a running database or a container runtime.
+        from convo.core.config import Settings, load_environment
+        from convo.core.contracts import Hit
+        from convo.pipeline.embeddings import Embedder
+        from convo.pipeline.reranking import Reranker
+
+        load_environment()
+        settings = Settings(
+            "",
+            os.getenv("EMBEDDING_MODEL", "Qwen/Qwen3-Embedding-0.6B"),
+            reranker_model=os.getenv("RERANKER_MODEL", "cross-encoder/ms-marco-MiniLM-L6-v2"),
+        )
+        print(
+            "Downloading/loading Qwen3 embeddings. First use can take several minutes.", flush=True
+        )
+        Embedder(settings.embedding_model).query("warm up")
+        print("Downloading/loading the local reranker…", flush=True)
+        Reranker(settings.reranker_model).rerank(
+            "What is being cached?", [Hit("Model weights are cached locally.", "warmup", 0.0)]
+        )
+        print("Both models are ready. Run convo and choose a file with /file.")
+        return
+
+    from convo.bootstrap import SetupError, ensure_storage
+
+    try:
+        ensure_storage()
+        settings = load_settings()
+    except (SetupError, ValueError) as error:
+        parser.error(str(error))
+
+    backend = RagBackend(settings)
+    try:
+        try:
+            app = ConvoApp(directory, backend, thinking_shortcut=args.thinking_key)
+        except ValueError as error:
+            parser.error(str(error))
+        app.run()
+    finally:
+        backend.close()
+
+
+if __name__ == "__main__":
+    main()