Metadata-Version: 2.5
Name: tramuri
Version: 0.13.3
Summary: From intent to a verifiable product definition with local-first agent integrations.
Project-URL: Homepage, https://github.com/tramuri/tramuri
Project-URL: Documentation, https://github.com/tramuri/tramuri/tree/main/docs
Project-URL: Issues, https://github.com/tramuri/tramuri/issues
Project-URL: Changelog, https://github.com/tramuri/tramuri/blob/main/CHANGELOG.md
Author: Tramuri maintainers
License:                                  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.
License-File: LICENSE
Keywords: agents,cli,product-engineering,product-management,workflow
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Requires-Dist: jinja2<4,>=3.1
Requires-Dist: rich<15,>=13.9
Requires-Dist: typer<1,>=0.16
Description-Content-Type: text/markdown

# Tramuri

<p align="center">
  <img src="https://raw.githubusercontent.com/tramuri/tramuri/main/assets/logo.png" alt="Tramuri logo" width="220">
</p>

<p align="center"><a href="https://github.com/tramuri/tramuri/blob/main/README.md">English</a> · <a href="https://github.com/tramuri/tramuri/blob/main/README.pt-BR.md">Português (Brasil)</a></p>

<p align="center"><strong>From intent to a verified product definition.</strong></p>

<p align="center">
  <a href="https://github.com/tramuri/tramuri/actions/workflows/ci.yml"><img src="https://github.com/tramuri/tramuri/actions/workflows/ci.yml/badge.svg?branch=main" alt="CI"></a>
  <a href="https://pypi.org/project/tramuri/"><img src="https://img.shields.io/pypi/v/tramuri" alt="PyPI version"></a>
</p>

Tramuri is a local-first Python tool for turning an incomplete product idea into
a structured, reviewable product result. It keeps workflow state in
SQLite, installs provider-native guidance for Codex, Claude Code and Gemini CLI,
and generates an offline report plus a navigable prototype.

The first release implements the product-definition workflow only. It does not
pretend to implement UX or Engineering modules, and it does not require a
hosted model or duplicate provider credentials.

The runtime is split into a provider-neutral core, the product capability module and
thin provider harnesses. The core owns workflow state and policy; harnesses own
native Codex, Claude Code and Gemini CLI projections. The public API exposes the
new core, product module and harness boundaries directly; deprecated facade
packages are not part of this release.

## Prerequisites

| Requirement | Minimum | Check | Install |
| --- | --- | --- | --- |
| Python | 3.10+ | `python --version` | [python.org](https://www.python.org/downloads/) |
| uv (recommended) | any | `uv --version` | `curl -LsSf https://astral.sh/uv/install.sh \| sh` |
| pipx (alternative) | current | `pipx --version` | `python -m pip install --user pipx` |

Platform shortcuts:

```bash
# macOS (Homebrew)
brew install python@3.12 uv

# Windows (PowerShell)
winget install --id=astral-sh.uv -e

# Ubuntu/Debian
sudo apt install python3.12 python3-pip pipx
# or install uv:
curl -LsSf https://astral.sh/uv/install.sh | sh
```

## Quickstart (30 seconds)

```bash
uv tool install tramuri
tramuri init --provider auto
```

Open your assistant in the same project and run the installed skill:

```text
/tramuri .        # Claude Code or Gemini CLI
$tramuri .        # Codex
```

That is enough to begin. Use `--provider all` instead of `auto` when you want
to install the project components for all three providers explicitly.

## Install

### Important

The official PyPI package is `tramuri`. The command installed on your `PATH` is
also `tramuri`. This project does not use the Graphify package name or command.

Choose one isolated CLI installation method:

```bash
uv tool install tramuri
# If `tramuri` is not found afterwards, restart the shell or run:
# uv tool update-shell
tramuri --version
```

Alternatively:

```bash
pipx install tramuri
# or
python -m pip install tramuri
```

No Rust, Node.js, Docker, hosted backend or duplicated provider API key is
required.

### Project-scoped provider installation

From the project you want Tramuri to accompany, install the native provider
components once. Installation is project-local by default:

```bash
tramuri init --provider auto       # detect providers available in this project
tramuri init --provider all        # explicitly install all built-in adapters
```

Then start Tramuri inside your assistant:

```text
Claude Code: /tramuri .
Gemini CLI:  /tramuri .
Codex:       $tramuri .
```

`/tramuri .` means “use this project as context”. Claude Code and Gemini expose
that name as a native slash command. Codex exposes project skills with its
official `$skill-name` notation, so `$tramuri .` is the guaranteed Codex form;
the installed instructions also recognize `/tramuri .` when it is sent as a
normal prompt.

Tramuri starts from the user's product intent. If the intent is missing, it asks
one concise grouped question about what to create or improve, who it serves and
the desired outcome. It does not invent a product. Once the intent is clear, it
defaults to MVP, records low-impact assumptions and asks only critical safety,
authorization or irreversible-decision gates.

The generated state and product artifacts stay together in one directory:

```text
tramuri_output/
├── portal/index.html                 # central product map
├── reports/<run-id>/report.html      # product report
├── reports/<run-id>/prototype.html  # offline navigation prototype
├── demo/                             # navigable product demo
├── database/tramuri.sqlite3          # durable workflow memory
├── manifests/                        # provider installation records
└── backups/                          # safe installer backups
```

Provider-native files remain in `.agents/`, `.claude/` or `.gemini/` because
those locations are how the assistants discover skills, commands and hooks.

The installed entry skill is written as:

```text
.agents/skills/tramuri/SKILL.md        # Codex
.claude/skills/tramuri/SKILL.md        # Claude Code
.gemini/skills/tramuri/SKILL.md        # Gemini CLI
.gemini/commands/tramuri.toml          # Gemini native /tramuri command
```

Use the terminal to inspect the same real workflow state:

```bash
tramuri status
tramuri runs list
tramuri resume <run-id>
```

## Common commands

Run the installed skill inside an assistant:

```text
/tramuri .                              # Claude Code or Gemini CLI
$tramuri .                              # Codex
/tramuri explain "value proposition"   # explain persisted product facts
$tramuri explain "MVP scope"            # Codex equivalent
```

Run deterministic or machine-readable operations from a shell:

```bash
tramuri --help
tramuri status
tramuri --json explain "value proposition"
tramuri product run --idea-file idea.md --mode mvp
tramuri product demo --mode mvp
tramuri experience check <run-id>
tramuri report open <run-id>
tramuri report open <run-id> --no-open
tramuri runs list
tramuri runs show <run-id>
tramuri resume <run-id>
tramuri providers list
tramuri doctor
tramuri init --provider all --dry-run
tramuri update --provider all
tramuri uninstall --provider codex
```

`explain` reads only persisted artifacts, decisions, dependencies and evidence
from `tramuri_output`. When a subject is not recorded, it reports that gap
instead of inventing an explanation.

If `tramuri` is not found after an isolated install, restart the shell or run
`uv tool update-shell`. If a provider is not detected, run `tramuri doctor` and
then install the provider's CLI using its official instructions. Tramuri never
installs third-party assistants or MCP servers automatically.

## Run the deterministic demo

```bash
tramuri product demo --mode mvp
tramuri runs list
tramuri report open <run-id> --no-open
```

The demo requires no network or provider authentication. Generated hypotheses
and example data are explicitly marked as synthetic.

Each demo also produces `tramuri_output/portal/index.html`, the Product
Experience map, and `tramuri_output/demo/index.html`, an offline Product Demo
with a real simulated journey. Open the portal to move from Product Definition
to the demo; Product UX and Product Engineering remain visible as future
stages. Validate the generated artifacts with `tramuri --json experience check
<run-id>`.

The workflow survives provider-session boundaries. Use `tramuri status` to see
the real stage position, checkpoint, sensor gates and next action, then
`tramuri resume <run-id>` to continue. Tramuri records local project knowledge
with provenance and treats repository documents as untrusted data. Low-impact
ambiguity becomes a recorded hypothesis; only critical authorization or safety
decisions become human gates.

## Install provider components

```bash
tramuri providers list
tramuri init --provider codex
tramuri init --provider claude
tramuri init --provider gemini
tramuri init --provider all --dry-run
```

Installation is project-local by default, idempotent, conflict-aware and
manifested. Existing unmanaged files are preserved.

## Development

```bash
uv sync --group dev
uv run pytest
uv run ruff check .
uv run mypy src/tramuri
uv build
```

See [docs/index.md](docs/index.md) for the architecture, provider capability
matrix, product workflow and release procedure.

## License

Apache-2.0. See [LICENSE](LICENSE).
