Skip to content

nkapp configure ​

Interactive wizard to set up a new Nanokit project.

Usage ​

bash
nkapp configure

It only runs on a fresh project

If a nanokit.yml already exists in the current directory, configure prints a notice, points you at nkapp service add, and exits without changing anything. It is a scaffolder, not an editor — it cannot merge into or update an existing configuration.

Description ​

The configure command is the guided way to start a new project from scratch:

  1. Naming: setting your project identifier (defaults to the directory name).
  2. Services: defining your initial application containers (e.g. web, api).

By the end of the wizard, Nanokit will create:

  • A nanokit.yml file with your settings.
  • A .nanokit directory for local logs and cache.

Example ​

bash
$ nkapp configure

🚀 Welcome to Nanokit Configuration Wizard

Project name [my-project]: my-awesome-app
Service names (comma separated, e.g. web, api) [web]: api, worker

✔ Project my-awesome-app configured!

Changing an existing configuration ​

GoalCommand
Add a servicenkapp service add
Change a service propertynkapp service set <name> <key=value>
Remove a servicenkapp service del <name>
Set any config pathnkapp config set <key=value>
Add a domainnkapp host add
Add a secretnkapp secrets set

Or just edit nanokit.yml directly — it is designed to be read and diffed by humans.


Tip. After running configure, try nkapp up -e local to see your new stack in action.