Installation¶
Requirements¶
- Ruby 3.2 or later
- Git (for version-controlled persistence)
Install from RubyGems¶
Add to Your Gemfile¶
Then run:
Install from Source¶
git clone https://github.com/MadBomber/trak_flow.git
cd trak_flow
bundle install
bundle exec rake install
Verify Installation¶
You should see:
Initialize a Project¶
Navigate to your project directory and run:
This creates a .trak_flow/ directory with:
issues.jsonl- Git-tracked task storagetrak_flow.db- SQLite cache (gitignored)config.json- Project configuration.gitignore- Ignores the database file
Dependencies¶
TrakFlow depends on these gems (installed automatically):
| Gem | Purpose |
|---|---|
thor |
CLI framework |
sqlite3 |
Local database |
oj |
Fast JSON parsing |
pastel |
Terminal colors |
tty-table |
Table formatting |
fast_mcp |
MCP server support |
puma |
HTTP server for MCP |
Next Steps¶
- Quick Start - Create your first tasks
- Configuration - Customize TrakFlow settings