kmux init
Register current directory as a kmux project
$ kmux init
Description
Register the current directory as a kmux project. This command creates a .kmux.yaml configuration file in the current directory and registers the project in the global kmux registry with an allocated port range. The project name is used as a unique identifier across all kmux projects. If --name is not provided, you will be prompted to enter a name (the directory name is offered as a default). Use --force to overwrite an existing .kmux.yaml file or to re-register a project that was previously registered at the same path.
Flags
| Flag | Description | Default |
|---|---|---|
| --force | overwrite existing .kmux.yaml or re-register project | false |
| --name | project name (skips interactive prompt) | — |
| --port | custom port range start (default: auto-assign next available) | 0 |
📖Learn More
See the Getting Started Guide for complete workflows and examples of using this command in real quests.