Docs Getting started
Install
Install the teamtrail command and open the Lookout for a repo.
#Requirements
- Node.js 20 or newer. Teamtrail has no other runtime dependencies.
- Git, for workspaces and git evidence. Teamtrail still runs in a folder without git.
#Run it
npm i -g teamtrail@next # or, without installing: npx teamtrail@next
cd your-repo
teamtrailteamtrail starts a local server, opens the Lookout in your browser and keeps trails as plain files in ./.teamtrail/ in the current folder. Agents and people can edit those files directly, and changes show up live.
Until launch, the real CLI is published under the
nexttag.teamtrail@latestis a placeholder that only prints a short message.
#Options
| Option | Default | |
|---|---|---|
--dir <path> | ./.teamtrail (or $TEAMTRAIL_DIR) | The tracker folder. |
--port <n> | 7420, or the next free port | Port for the Lookout and its API. |
--host <addr> | 127.0.0.1 | Interface to bind. The server can write files in the tracker folder, so only expose it on networks you trust. |
--no-open | Don't open the browser. | |
-v, --version | Print the version. | |
-h, --help | Show the help. |
See CLI commands for every command.
#Updating
- With
npx teamtrail@next, you always get the currentnextversion. npx caches package metadata for a few minutes, so a release can take a moment to show up. - With a global install, run
npm i -g teamtrail@nextagain. There's no need to uninstall first.
#Commit .teamtrail/ or not
Commit the shared files (trails, decisions, briefs, criteria, knowledge and the config files) so your team and your agents see the same state. Local-only folders such as the journal, evidence and agent coordination come with their own .gitignore. See The .teamtrail folder for which is which.