# Create a new project

To scaffold the project with the CLI, run the following commands. This will create a new project directory, and populate the directory with the initial core Ts.ED files and supporting modules, creating a conventional base structure for your project. Creating a new project with the CLI is recommended for first-time users.

npm install -g @tsed/cli
tsed init .

1
2

TIP

See our CLI website (opens new window) for more details on the CLI commands.

You can select different options to generate your first application:

The web framework: Express.js / Koa.js
The convention project architecture: Ts.ED or Feature
The convention file styling: Ts.ED or Angular
The features:
- Graphql,
- Database,
- Passport.js,
- Socket.io,
- Swagger,
- OIDC,
- Testing (Jest/Vitest/Mocha),
- Linter (Eslint, prettier),
The runtime: Node.js, Node.js + Babel, Node.js + Webpack, Node.js + SWC, Bun
The Package manager: NPM, Yarn, PNPM, Bun

TIP

By default, it's recommended to select the following options: Express, Ts.ED (convention), Swagger, Jest and Eslint + prettier.

When all options are selected, the CLI will generate all files. When it's done, run one of this command:

yarn start
npm start
pnpm start

1
2
3

# Update dependencies

WARNING

If you have to upgrade Ts.ED dependencies, keep in mind this point:

It's really important to keep the same version for all @tsed/* (excepted @tsed/logger) packages. To prevent errors, fix the version for each Ts.ED packages:

{
  "dependencies": {
    "@tsed/common": "7.0.0",
    "@tsed/di": "7.0.0",
    "@tsed/core": "7.0.0",
    "@tsed/exceptions": "7.0.0",
    "@tsed/plaftorm-express": "7.0.0",
    "@tsed/swagger": "7.0.0"
  }
}