# TriStack

> A modern CLI for scaffolding projects across Python, Go, and Rust (Python first) with best practices and customizable configurations.

## When to use TriStack

Use TriStack when a developer or coding agent needs to scaffold a new project (Python, Go, or Rust), reproduce a selected stack from a command, inspect compatibility rules, or generate a project through a structured interface.

TriStack does not expose a public hosted application API. The supported automation interfaces are the CLI and its JSON-first `create-json` command. Native agent plugins are planned.

## Quick start

```bash
uvx tristack my-api
```

Non-interactive default project:

```bash
uvx tristack my-api --yes
```

## Agent interfaces

- JSON project creation: `tristack create-json --json '{...}'`
- Dry-run validation: `tristack create-json --json '{"projectName":"my-api","dryRun":true}'`
- [Agent workflow guide](https://tristack.space/docs/cli/agent-workflows.mdx)

## Documentation

- [Quick Start](https://tristack.space/docs/index.mdx) — Create your first TriStack project in minutes
- [Commands](https://tristack.space/docs/cli.mdx) — Complete reference for all TriStack CLI commands
- [Agent Workflows](https://tristack.space/docs/cli/agent-workflows.mdx) — JSON-first and schema-driven workflows for agents, scripts, and automation
- [Compatibility Rules](https://tristack.space/docs/cli/compatibility.mdx) — Understanding compatibility rules and restrictions between different CLI options
- [Options Reference](https://tristack.space/docs/cli/options.mdx) — Complete reference for all TriStack CLI options and flags
- [Using the interactive prompts](https://tristack.space/docs/cli/prompts.mdx) — How to navigate and answer the CLI's interactive questions
- [Contributing](https://tristack.space/docs/contributing.mdx) — How to set up your environment and contribute changes
- [Frequently Asked Questions](https://tristack.space/docs/faq.mdx) — Short answers to common beginner questions
- [Guides](https://tristack.space/docs/guides.mdx) — Practical guides for common setups
- [Go Quick Start](https://tristack.space/docs/guides/go-quick-start.mdx) — Scaffold and run your first Gin + GORM project end to end
- [Python Quick Start](https://tristack.space/docs/guides/python-quick-start.mdx) — Scaffold and run your first FastAPI project end to end
- [Rust Quick Start](https://tristack.space/docs/guides/rust-quick-start.mdx) — Scaffold and run your first Axum + SeaORM project end to end
- [Project Structure](https://tristack.space/docs/project-structure.mdx) — Understanding the structure of projects created by the TriStack CLI
- [tristack.jsonc](https://tristack.space/docs/tristack-config.mdx) — What tristack.jsonc does and why it matters

## Project resources

- [Complete documentation in one Markdown file](https://tristack.space/llms-full.txt)
- [Browser stack builder](https://tristack.space/new)
- [GitHub repository](https://github.com/AbdullahMukadam/tristack)
- [Sitemap](https://tristack.space/sitemap.xml)
- [Privacy notice](https://tristack.space/privacy)
- [Contact](https://tristack.space/contact)