Quickstart

Get started with Ninja in four steps.

1. Install Ninja

See the Installation Guide for CLI and GUI options.

2. Install a Shuriken

shurikenctl install path/to/service.shuriken

The shuriken is extracted to ~/.ninja/shurikens/{name}/.

3. Configure (Optional)

If the shuriken includes configuration templates:

# Edit options
nano ~/.ninja/shurikens/{name}/.ninja/options.toml

# Generate config
shurikenctl configure {name}

4. Start the Service

# Start the service
shurikenctl start {name}

# Check status
shurikenctl list

Next Steps

• Learn about Configuration and templates
• Explore the User Guide for daily operations
• Build your own shurikens in the Developer Guide