CLI Reference

https://github.com/xellu/nautica-api/tree/main/nautica/cli

Nautica3 comes with a built-in CLI for managing your projects

Quick Start

nautica create my-project
cd my-project
nautica run .

To set up an existing project:

cd my-project
nautica install
nautica run .

Commands

create

• Usage: nautica create <name>

Creates a new Nautica3 project in a new directory with the given name. Generated project tree:

new-project/
├── src/
│   └── http/ //feel free to delete if not needed
│       └── +root.py
├── plugins/
├── config/
├── .logs/
├── config.n3
├── package.n3
└── .gitignore

After creating a project, cd into it and run nautica run . to start it.

install

• Usage: nautica install (or nautica i)

Checks that needed config files are present, onInstall() on all registered services and creates any missing configs.

Should be ran after cloning an existing N3 project, or after adding new services.

run

• Usage: nautica run <path>

Starts a Nautica3 project. Pass . to run the project in the current directory.