Getting Started
It is really simple to get started with the TNT Stack. All you need to do is to run the following command, and answer the prompts:
Installation
npm
npm create tnt-stack@latestyarn
yarn create tnt-stackpnpm
pnpm create tnt-stack@latestbun
bun create tnt-stack@latestIt is as simple as that. Once you have answered all the prompts, you can checkout the First Steps section to learn more about how to use the TNT Stack.
Advanced Installation
The CLI comes with several flags that can be used to customize the installation process, or skip certain prompts.
| Flags | Description |
|---|---|
[dir] | The name of the application, as well as the name of the directory to create. |
--noGit | Explicitly tell the CLI to not initialize a new git repo in the project. |
--noInstall | Generate project without installing dependencies. |
-y, --default | Bypass the CLI and bootstrap a new TNT Stack project with all options selected |
Experimental CI flags
The CI flag can be used to scaffold a new project without prompts. This is useful for CI/CD pipelines.
| Flags | Description |
|---|---|
--CI | Set the CLI to run in CI mode. |
--nextAuth | Set the CLI to scaffold a project with NextAuth.js. |
--prisma | Set the CLI to scaffold a project with Prisma. |
--prettier | Set the CLI to scaffold a project with Prettier. |
-I, --import-alias [alias] | Set the CLI to scaffold a project with Import Alias. |
--dbProvider [provider] | Set the CLI to scaffold a project with a database. |
If you don’t provide the CI flag, the rest of these flags have no effect.
Examples
Unless specified otherwise, all flags are boolean flags. This mean that they don’t require a value to be passed to them. For example, to scaffold a project with NextAuth.js, you would run:
npm create tnt-stack@latest --CI --nextAuthFor flags that require a value, you would pass the value after the flag. For example, to scaffold a project with a database provider, you would run:
npm create tnt-stack@latest --CI --dbProvider postgresql