Guide
Trama keeps a map of your app next to your code and turns every change your agent makes into a Proposal you approve first. The guide explains how to use it, in four sections.
Getting started
- Requirements — What Trama needs: VS Code, a supported platform, omp, and the GitHub CLI only for Team.
- Install the extension — Install Trama from the VS Code Marketplace or from a .vsix file.
- First run of omp — Install omp, log in to a model provider and choose the models Trama uses.
- Put Trama in a project — The Get Started wizard, step by step, with its two paths: Import from Code and Start from Scratch.
Concepts
- The Model — The System, its Features, Machines, States, Transitions, Events and Actors.
- Requirements and skills — How the System must be built, kept beside the Model, and the skills the agent reads.
- Specs — The technologies the project uses, in one place the agent reads.
- Proposals, Tasks and Drifts — The three kinds of card, and the ghosts that announce them.
- The Board and the History — What waits for you, what is in progress, what is done, and the story of the work.
Workflows
- Design a change — Describe a change in plain words, answer the agent's questions and receive a Proposal.
- Review, approve or reject a Proposal — Read a Proposal on the Diagram and the Requirements, then decide.
- Rework with feedback — Reject a Proposal, or send back a Drift, and have the agent redo it following your feedback.
- Run Tasks — Have the agent build Tasks one at a time or all together, and follow it on the Board.
- Scan the System — Have the agent compare the Model with the code and turn the differences into Tasks and Drifts.
- Resolve Drifts — Decide between the code and the Model, with the Fix options the agent offers.
- Unify Drifts — Merge every open Drift into one, so conflicting differences are settled together.
- Import from code — Describe an existing project as a Model, as it is, through Proposals.
- Start from Scratch — Describe an application still to be built and receive its first Model and the Tasks that build it.
- Refine stale Proposals — Let the agent bring an open Proposal up to date when the Model changed under it.
- Solo mode and Merge — Use Trama alone in a repository where the others do not, and merge their work back into the Model.
- Manager mode and Team — Plan work for the people of a team, publish it as GitHub issues and follow it on a timeline.
Panel & settings
- The panel and the side menu — Every view of the Trama panel, and the side menu that opens them.
- The Diagram and its focus — Draw the Model at any zoom level, with a Proposal on top, and step through what a card touches.
- omp Chat and General — The conversations with the agent, one for each job, and General for thinking with omp.
- Away notifications — Get a notification on your devices when the agent finishes or waits for you.
- Settings — Every setting of the extension, with what it does and its default.