tala-ai 3.0.0__tar.gz

tala_ai-3.0.0/.gitignore

@@ -0,0 +1,16 @@
+.venv/
+__pycache__/
+*.py[cod]
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.ruff_cache/
+.coverage
+htmlcov/
+dist/
+build/
+*.db
+*.db-*
+.tala/data/
+.import_linter_cache/
+.tala-home*/

tala_ai-3.0.0/CHANGELOG.md

@@ -0,0 +1,30 @@
+# Changelog
+
+## 3.0.0
+
+Complete rebuild of the v2 prototype. See [docs/from-v2.md](docs/from-v2.md).
+
+### Added
+- One-line installers (`install.ps1`, `install.sh`) and a first-run setup wizard (`tala setup`):
+  hardware detection, default or advanced setup from a curated model catalog, memory estimates,
+  resource warnings, safe config merging with backup, and guided model downloads.
+- LangChain + LangGraph agent: route, executor loop (bounded), authorize (interrupt), run, summarize.
+- Pack format with logical tools, per-OS variants, typed parameters with constraints, conditional
+  arguments, defaults, layered pack directories, strict loader and `tala packs validate`.
+- About 200 builtin tools: system, processes, network and files (cross-platform) plus git (and GitHub CLI),
+  docker, adb, fastboot, Python/pip/uv, Java/Maven/Gradle, Node/Yarn/pnpm, .NET/Go/Rust/Ruby, curl, SSH,
+  firewall, services, apt/Homebrew/Chocolatey, system logs, file reading, searching, hashing, copying
+  and archiving, and winget, powercfg, schtasks and wevtutil on Windows.
+- Summary-first output for content-heavy tools (web pages, files, logs, diffs): the reply ends with an offer
+  of the original output, which a "yes" shows verbatim (pack key `offer_original`, setting
+  `runtime.offer_original_output`).
+- Hybrid tool retrieval (FTS5 BM25 + sqlite-vec, RRF) with confidence-driven routing.
+- Safety: mandatory risk, policy engine, exact-command approval, untrusted-output fencing, audit log,
+  bounded subprocess execution with tree kill.
+- Session persistence (SQLite checkpoints), history budgeting, long-term facts.
+- Typed event service API; Typer/rich CLI (`chat`, `ask`, `packs`, `facts`, `audit`, `doctor`, `eval`).
+- Golden-set evaluation (retrieval and live agent), architecture contract tests, CI matrix.
+
+### Removed
+- `scrcpy_mirror`, `scrcpy_mirror_screen_off` (long-running GUI processes).
+- The v2 `FileSystemGateway` (unused).

tala_ai-3.0.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

tala_ai-3.0.0/NOTICE

@@ -0,0 +1,7 @@
+Tala
+Copyright 2026 Achintha Bandara
+
+This product includes software developed by Achintha Bandara
+(https://github.com/AchinthaShiran/Tala).
+
+Licensed under the Apache License, Version 2.0. See the LICENSE file.

tala_ai-3.0.0/PKG-INFO

@@ -0,0 +1,232 @@
+Metadata-Version: 2.5
+Name: tala-ai
+Version: 3.0.0
+Summary: Local, OS-agnostic desktop AI assistant: YAML tool packs, LangGraph agent, Ollama.
+Project-URL: Homepage, https://github.com/AchinthaShiran/Tala
+Project-URL: Source, https://github.com/AchinthaShiran/Tala
+Project-URL: Issues, https://github.com/AchinthaShiran/Tala/issues
+Project-URL: Changelog, https://github.com/AchinthaShiran/Tala/blob/main/CHANGELOG.md
+Project-URL: Documentation, https://github.com/AchinthaShiran/Tala/tree/main/docs
+Author: Achintha Bandara
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: ai,assistant,cli,desktop-assistant,langchain,langgraph,local-llm,ollama,tool-calling
+Classifier: Development Status :: 4 - Beta
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: End Users/Desktop
+Classifier: Operating System :: MacOS
+Classifier: Operating System :: Microsoft :: Windows
+Classifier: Operating System :: POSIX :: Linux
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Utilities
+Requires-Python: >=3.11
+Requires-Dist: langchain-core<2,>=1.0
+Requires-Dist: langchain-ollama<2,>=1.0
+Requires-Dist: langgraph-checkpoint-sqlite<4,>=3.0
+Requires-Dist: langgraph<2,>=1.0
+Requires-Dist: platformdirs>=4.2
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: rich>=13.7
+Requires-Dist: sqlite-vec>=0.1.6
+Requires-Dist: typer>=0.12
+Provides-Extra: dev
+Requires-Dist: import-linter>=2.0; extra == 'dev'
+Requires-Dist: mypy>=1.11; extra == 'dev'
+Requires-Dist: pytest-cov>=5; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: ruff>=0.6; extra == 'dev'
+Requires-Dist: types-pyyaml; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# Tala
+
+A local, OS-agnostic AI assistant for your PC. Chat in plain language; a local model (via
+[Ollama](https://ollama.com)) picks and runs **tools** defined in simple YAML files called **packs**.
+Nothing leaves your machine, and nothing risky runs without your approval.
+
+```
+You: how much free disk space do I have?
+→ disk_free (read_only)  powershell -NoProfile ... Get-PSDrive ...
+  ✓ disk_free · 1093 ms
+Assistant: Drive C has 9.2 GB free and drive D has 66.9 GB free.
+
+You: stop the docker container web
+╭──────────── Approval needed ────────────╮
+│ docker_stop  mutating                   │
+│ command: /usr/bin/docker stop web       │
+╰─────────────────────────────────────────╯
+Run it? [y/N]
+```
+
+## Why it is built this way
+
+| Goal | How |
+| --- | --- |
+| **Add capabilities with YAML only** | Drop a file in a pack directory. No Python, no restart of design. See [pack authoring](docs/pack-authoring.md). |
+| **Works on Windows, Linux and macOS** | One *logical* tool (`ping_host`) with per-OS command variants. Tools whose executable is missing are never offered to the model. |
+| **Safe by default** | Mandatory risk level per tool, approval policy, exact command shown, no shell, argument constraints, untrusted-output fencing, audit log. See [safety](docs/safety.md). |
+| **Runs on small local models** | Hybrid keyword + vector tool retrieval offers the model 4-8 tools instead of 100; arguments are validated and repaired; chat never loads the tool machinery. |
+| **Engineered to grow** | LangChain + LangGraph agent, typed event API for any front end, layered architecture enforced by tests. See [architecture](docs/architecture.md). |
+
+## Quick start
+
+You need [Ollama](https://ollama.com/download) running locally.
+
+**One-line install** (installs into an isolated environment, then starts the setup wizard):
+
+```powershell
+irm https://raw.githubusercontent.com/AchinthaShiran/Tala/main/install.ps1 | iex   # Windows
+```
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/AchinthaShiran/Tala/main/install.sh | sh   # macOS / Linux
+```
+
+**Or from PyPI** (needs Python 3.11 or newer, not a specific version):
+
+```sh
+pipx install tala-ai      # or: uv tool install tala-ai
+tala setup
+```
+
+**From a clone:**
+
+```bash
+python -m venv .venv && . .venv/bin/activate        # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+tala setup           # pick Default or Advanced; detects your hardware and warns about heavy models
+tala chat            # start talking
+```
+
+`tala setup` offers three setups: **Default** (one fixed, conservative configuration, the same everywhere),
+**Recommended** (tailored to your detected hardware) and **Advanced** (choose models, context size, memory
+use, approval rules and speed options from curated sets, with warnings when a choice will strain your
+machine). Whichever you pick, the full settings are shown and you confirm before anything is applied. It
+also offers itself the first time you run `tala chat`. Details: [docs/setup.md](docs/setup.md).
+`tala doctor` re-checks everything at any time.
+
+Other commands:
+
+| Command | Purpose |
+| --- | --- |
+| `tala setup [--default\|--recommended\|--advanced] [--check]` | First-run wizard: hardware-aware setup and model downloads |
+| `tala ask "..."` | One question, then exit |
+| `tala packs list [--all]` | Tools available here (and why others are not) |
+| `tala packs show NAME` | Full definition of a tool |
+| `tala packs validate [PATH...] [--strict]` | Lint packs (use in CI for your own packs) |
+| `tala packs trust [DIR] [--revoke]` | Allow packs from `<DIR>/.tala/packs` (untrusted by default) |
+| `tala facts add/list/remove` | Things the assistant should always remember ("my phone is 192.168.1.20") |
+| `tala audit` | Recent tool executions |
+| `tala eval retrieval [--embeddings]` / `tala eval agent` | Measure tool-selection quality on the golden set |
+
+Inside `tala chat`: `/tools`, `/history`, `/reset`, `/exit`. Sessions are saved and resume automatically
+(`tala chat --session work`).
+
+## Add your own tool in two minutes
+
+Create `~/.config/tala/packs/mine.yaml` (Windows: `%LOCALAPPDATA%\tala\packs\`;
+run `tala doctor` to see the exact path), or `./.tala/packs/` for a per-project pack (project packs load only after `tala packs trust`,
+because a pack defines what may run on your machine):
+
+```yaml
+pack: mine
+tools:
+  - name: git_branch_list
+    description: List the local git branches of the current repository.
+    risk: read_only
+    examples: [which branches do I have, list my git branches]
+    run:
+      any: {exe: git, args: [branch, --list]}
+```
+
+```bash
+tala packs validate      # catches mistakes before the model ever sees the tool
+tala chat                # "which branches do I have?"
+```
+
+## Configuration
+
+Optional `config.yaml` (location shown by `tala doctor`). Everything has a default; override only what
+you need. Environment variables use `TALA__SECTION__KEY=value`.
+
+```yaml
+models:
+  main:   {name: "gemma4:e4b", num_ctx: 8192}     # shared by chat, executor, summarizer
+  router: {name: "granite4.1:3b", num_ctx: 2048}
+agents:
+  executor: {model: main, temperature: 0.1}
+runtime:
+  max_steps: 3                                    # tool rounds per request
+  direct_output_chars: 600                        # fastest: show small results without a summary
+safety:
+  tool_overrides: {git_status: auto, docker_ps: ask}
+packs:
+  dirs: [~/team-packs]
+  disabled_tools: [kill_process]
+```
+
+Full reference: [docs/configuration.md](docs/configuration.md). For response speed (time to first output,
+fast path, warm-up) see [docs/performance.md](docs/performance.md).
+
+## Project layout
+
+```
+src/assistant/
+  domain/      pure models: ToolSpec, risk levels, events, errors
+  packs/       YAML loading, lint, per-OS availability registry
+  tools/       argument validation, argv rendering, bounded subprocess runner, LangChain tools
+  retrieval/   hybrid BM25 + vector tool index with confidence tiers
+  safety/      approval policy, audit log, output fencing
+  llm/         model factory (Ollama; pluggable), health checks
+  memory/      session checkpoints, history budgeting, long-term facts
+  agent/       LangGraph: route -> executor -> authorize -> run -> summarize
+  service.py   Assistant.send()/resume() -> typed events (the only front-end contract)
+  bootstrap.py composition root
+  cli/         thin Typer/rich front end
+  builtin_packs/  95 tools (system, processes, network, files, git, docker, adb, npm, winget ...)
+tests/         unit, pack quality gate, integration (scripted model), architecture
+```
+
+## Renaming or rebranding
+
+The product name, command, environment-variable prefix and folder names live in one file:
+[`src/assistant/domain/branding.py`](src/assistant/domain/branding.py). Change the constants there, rename
+the console script and project name in `pyproject.toml`, and search-replace the Markdown docs. A test
+(`tests/test_branding.py`) fails if the code base hard-codes any of these elsewhere.
+
+## Development
+
+```bash
+pytest                      # 251 tests, fully offline (93% coverage)
+ruff check . && ruff format --check .
+mypy                        # strict
+lint-imports                # layer contracts (also part of pytest)
+tala eval retrieval -v       # tool-selection regression check
+```
+
+CI runs all of the above on Windows, Linux and macOS (`.github/workflows/ci.yml`).
+
+## Status and limits (v3.0)
+
+- Front end: CLI. The service API is front-end agnostic; an HTTP/WebSocket or tray adapter is the next step.
+- Long-running/interactive programs (GUI apps, `scrcpy` mirroring) are not supported as tools yet.
+- Commands are not OS-sandboxed; protection comes from approval policy, constraints and bounded execution.
+- Small models (2-4B) make mistakes. Measure with `tala eval agent` before trusting a model, and keep
+  mutating tools on `ask`.
+
+See [CHANGELOG](CHANGELOG.md) and the decision records in [.10x/adrs](.10x/adrs). Maintainers: releasing
+is described in [docs/publishing.md](docs/publishing.md).
+
+## License
+
+Copyright 2026 Achintha Bandara. Licensed under the [Apache License, Version 2.0](LICENSE): you may use,
+modify and distribute it, including commercially, as long as you keep the copyright and [NOTICE](NOTICE)
+files and state significant changes. It includes an explicit patent grant and comes with no warranty.

tala_ai-3.0.0/README.md

@@ -0,0 +1,184 @@
+# Tala
+
+A local, OS-agnostic AI assistant for your PC. Chat in plain language; a local model (via
+[Ollama](https://ollama.com)) picks and runs **tools** defined in simple YAML files called **packs**.
+Nothing leaves your machine, and nothing risky runs without your approval.
+
+```
+You: how much free disk space do I have?
+→ disk_free (read_only)  powershell -NoProfile ... Get-PSDrive ...
+  ✓ disk_free · 1093 ms
+Assistant: Drive C has 9.2 GB free and drive D has 66.9 GB free.
+
+You: stop the docker container web
+╭──────────── Approval needed ────────────╮
+│ docker_stop  mutating                   │
+│ command: /usr/bin/docker stop web       │
+╰─────────────────────────────────────────╯
+Run it? [y/N]
+```
+
+## Why it is built this way
+
+| Goal | How |
+| --- | --- |
+| **Add capabilities with YAML only** | Drop a file in a pack directory. No Python, no restart of design. See [pack authoring](docs/pack-authoring.md). |
+| **Works on Windows, Linux and macOS** | One *logical* tool (`ping_host`) with per-OS command variants. Tools whose executable is missing are never offered to the model. |
+| **Safe by default** | Mandatory risk level per tool, approval policy, exact command shown, no shell, argument constraints, untrusted-output fencing, audit log. See [safety](docs/safety.md). |
+| **Runs on small local models** | Hybrid keyword + vector tool retrieval offers the model 4-8 tools instead of 100; arguments are validated and repaired; chat never loads the tool machinery. |
+| **Engineered to grow** | LangChain + LangGraph agent, typed event API for any front end, layered architecture enforced by tests. See [architecture](docs/architecture.md). |
+
+## Quick start
+
+You need [Ollama](https://ollama.com/download) running locally.
+
+**One-line install** (installs into an isolated environment, then starts the setup wizard):
+
+```powershell
+irm https://raw.githubusercontent.com/AchinthaShiran/Tala/main/install.ps1 | iex   # Windows
+```
+
+```sh
+curl -fsSL https://raw.githubusercontent.com/AchinthaShiran/Tala/main/install.sh | sh   # macOS / Linux
+```
+
+**Or from PyPI** (needs Python 3.11 or newer, not a specific version):
+
+```sh
+pipx install tala-ai      # or: uv tool install tala-ai
+tala setup
+```
+
+**From a clone:**
+
+```bash
+python -m venv .venv && . .venv/bin/activate        # Windows: .venv\Scripts\activate
+pip install -e ".[dev]"
+tala setup           # pick Default or Advanced; detects your hardware and warns about heavy models
+tala chat            # start talking
+```
+
+`tala setup` offers three setups: **Default** (one fixed, conservative configuration, the same everywhere),
+**Recommended** (tailored to your detected hardware) and **Advanced** (choose models, context size, memory
+use, approval rules and speed options from curated sets, with warnings when a choice will strain your
+machine). Whichever you pick, the full settings are shown and you confirm before anything is applied. It
+also offers itself the first time you run `tala chat`. Details: [docs/setup.md](docs/setup.md).
+`tala doctor` re-checks everything at any time.
+
+Other commands:
+
+| Command | Purpose |
+| --- | --- |
+| `tala setup [--default\|--recommended\|--advanced] [--check]` | First-run wizard: hardware-aware setup and model downloads |
+| `tala ask "..."` | One question, then exit |
+| `tala packs list [--all]` | Tools available here (and why others are not) |
+| `tala packs show NAME` | Full definition of a tool |
+| `tala packs validate [PATH...] [--strict]` | Lint packs (use in CI for your own packs) |
+| `tala packs trust [DIR] [--revoke]` | Allow packs from `<DIR>/.tala/packs` (untrusted by default) |
+| `tala facts add/list/remove` | Things the assistant should always remember ("my phone is 192.168.1.20") |
+| `tala audit` | Recent tool executions |
+| `tala eval retrieval [--embeddings]` / `tala eval agent` | Measure tool-selection quality on the golden set |
+
+Inside `tala chat`: `/tools`, `/history`, `/reset`, `/exit`. Sessions are saved and resume automatically
+(`tala chat --session work`).
+
+## Add your own tool in two minutes
+
+Create `~/.config/tala/packs/mine.yaml` (Windows: `%LOCALAPPDATA%\tala\packs\`;
+run `tala doctor` to see the exact path), or `./.tala/packs/` for a per-project pack (project packs load only after `tala packs trust`,
+because a pack defines what may run on your machine):
+
+```yaml
+pack: mine
+tools:
+  - name: git_branch_list
+    description: List the local git branches of the current repository.
+    risk: read_only
+    examples: [which branches do I have, list my git branches]
+    run:
+      any: {exe: git, args: [branch, --list]}
+```
+
+```bash
+tala packs validate      # catches mistakes before the model ever sees the tool
+tala chat                # "which branches do I have?"
+```
+
+## Configuration
+
+Optional `config.yaml` (location shown by `tala doctor`). Everything has a default; override only what
+you need. Environment variables use `TALA__SECTION__KEY=value`.
+
+```yaml
+models:
+  main:   {name: "gemma4:e4b", num_ctx: 8192}     # shared by chat, executor, summarizer
+  router: {name: "granite4.1:3b", num_ctx: 2048}
+agents:
+  executor: {model: main, temperature: 0.1}
+runtime:
+  max_steps: 3                                    # tool rounds per request
+  direct_output_chars: 600                        # fastest: show small results without a summary
+safety:
+  tool_overrides: {git_status: auto, docker_ps: ask}
+packs:
+  dirs: [~/team-packs]
+  disabled_tools: [kill_process]
+```
+
+Full reference: [docs/configuration.md](docs/configuration.md). For response speed (time to first output,
+fast path, warm-up) see [docs/performance.md](docs/performance.md).
+
+## Project layout
+
+```
+src/assistant/
+  domain/      pure models: ToolSpec, risk levels, events, errors
+  packs/       YAML loading, lint, per-OS availability registry
+  tools/       argument validation, argv rendering, bounded subprocess runner, LangChain tools
+  retrieval/   hybrid BM25 + vector tool index with confidence tiers
+  safety/      approval policy, audit log, output fencing
+  llm/         model factory (Ollama; pluggable), health checks
+  memory/      session checkpoints, history budgeting, long-term facts
+  agent/       LangGraph: route -> executor -> authorize -> run -> summarize
+  service.py   Assistant.send()/resume() -> typed events (the only front-end contract)
+  bootstrap.py composition root
+  cli/         thin Typer/rich front end
+  builtin_packs/  95 tools (system, processes, network, files, git, docker, adb, npm, winget ...)
+tests/         unit, pack quality gate, integration (scripted model), architecture
+```
+
+## Renaming or rebranding
+
+The product name, command, environment-variable prefix and folder names live in one file:
+[`src/assistant/domain/branding.py`](src/assistant/domain/branding.py). Change the constants there, rename
+the console script and project name in `pyproject.toml`, and search-replace the Markdown docs. A test
+(`tests/test_branding.py`) fails if the code base hard-codes any of these elsewhere.
+
+## Development
+
+```bash
+pytest                      # 251 tests, fully offline (93% coverage)
+ruff check . && ruff format --check .
+mypy                        # strict
+lint-imports                # layer contracts (also part of pytest)
+tala eval retrieval -v       # tool-selection regression check
+```
+
+CI runs all of the above on Windows, Linux and macOS (`.github/workflows/ci.yml`).
+
+## Status and limits (v3.0)
+
+- Front end: CLI. The service API is front-end agnostic; an HTTP/WebSocket or tray adapter is the next step.
+- Long-running/interactive programs (GUI apps, `scrcpy` mirroring) are not supported as tools yet.
+- Commands are not OS-sandboxed; protection comes from approval policy, constraints and bounded execution.
+- Small models (2-4B) make mistakes. Measure with `tala eval agent` before trusting a model, and keep
+  mutating tools on `ask`.
+
+See [CHANGELOG](CHANGELOG.md) and the decision records in [.10x/adrs](.10x/adrs). Maintainers: releasing
+is described in [docs/publishing.md](docs/publishing.md).
+
+## License
+
+Copyright 2026 Achintha Bandara. Licensed under the [Apache License, Version 2.0](LICENSE): you may use,
+modify and distribute it, including commercially, as long as you keep the copyright and [NOTICE](NOTICE)
+files and state significant changes. It includes an explicit patent grant and comes with no warranty.