CLI

@sukujs/cli gives you the suku command. It creates projects, generates code that follows the conventions in these docs, and wraps the commands to run, build and start an app.

bunx @sukujs/cli new my-api

Inside a project the CLI is a dev dependency, so suku is available to your scripts and through bunx suku.

Creating a projectCopy Anchor Link

suku new my-api

In a terminal, suku new asks for anything you did not pass as a flag:

Move with the arrow keys, toggle a deployment target with space, confirm with enter. Pass --yes to ask nothing and take the defaults, which is what happens in CI, where there is no terminal.

suku new my-api --yes
suku new my-api --runtime bun --deploy docker,cloudflare --skip-git

What you getCopy Anchor Link

my-api/
  src/
    main.ts              # creates the app, listens, shuts down on SIGTERM
    config.ts            # the environment, validated at startup
    app.feature.ts       # the root feature and a /health route
    app.test.ts          # tests that call the app in process
    hello/
      hello.feature.ts
      hello.routes.ts
      hello.service.ts
  package.json
  tsconfig.json

Deployment targetsCopy Anchor Link

Each target you pick adds its files and a section in the project's README. They follow the deployment guide.

Generating codeCopy Anchor Link

suku generate <schematic> <name>
suku g <schematic> <name>

Generated code is registered for you:

• a feature or resource is added to imports in src/app.feature.ts, or to features in your entry file when there is no root feature
• routes and a service are added to the feature file in the same folder

suku g resource products

CREATE src/products/products.schemas.ts (459 bytes)
CREATE src/products/products.service.ts (1020 bytes)
CREATE src/products/products.routes.ts (946 bytes)
CREATE src/products/products.feature.ts (290 bytes)
CREATE src/products/products.test.ts (1107 bytes)
UPDATE src/app.feature.ts (467 bytes)

That is a working GET, POST, PATCH and DELETE on /products with validated input, an in-memory service to replace with a repository, and a passing test.

OptionsCopy Anchor Link

A name can be written any way (userProfiles, user_profiles, user-profiles); files are kebab-case and classes are PascalCase. A name with a folder, such as admin/reports, generates into src/admin/reports/.

The CLI never overwrites a file unless you pass --force. If it cannot find where to register something, it says so and leaves the file alone.

Running, building, startingCopy Anchor Link

suku dev      # run src/main.ts with Bun, restart on change
suku build    # bundle the app and its dependencies into dist/
suku start    # run dist/main.js with the production runtime

Arguments after -- go to your app: suku dev -- --port 4000.

Project settingsCopy Anchor Link

The CLI reads an optional suku field in package.json.

{
  "suku": {
    "runtime": "node",
    "sourceRoot": "src",
    "entry": "src/main.ts"
  }
}

Reporting a problemCopy Anchor Link

suku info prints the versions of the CLI, Node, Bun and every @sukujs/* package in the project. Include it in bug reports.