CLI reference

CLI reference#

limanix#

Development sandboxes with Lima and NixOS.

Usage:
  limanix [flags]
  limanix [command]

Available Commands:
  create        Create a development sandbox from a TOML configuration.
  delete        Delete a VM; preserve its managed host home by default.
  first-config  Write the default limanix.toml.
  help          Help about any command
  list          List VMs managed by Limanix.
  modules       Manage bundled and third-party NixOS modules.
  network       Prepare Lima's macOS networking for QEMU guests.
  shell         Connect as the configured development user.
  start         Start an existing VM.
  stop          Stop a VM and preserve its disk and home.
  update        Apply a configuration and restart an existing VM.

Flags:
  -h, --help   help for limanix

Use "limanix [command] --help" for more information about a command.

limanix create#

Create a development sandbox from a TOML configuration.

Usage:
  limanix create [flags]

Flags:
      --config string   Path to the VM configuration file (required).
  -h, --help            help for create

limanix delete#

Delete a VM; preserve its managed host home by default.

Usage:
  limanix delete NAME [flags]

Flags:
      --force         Force Lima to stop and delete the VM.
  -h, --help          help for delete
      --remove-home   Also remove this VM's managed host home and its contents.

limanix first-config#

Write the default limanix.toml.

Usage:
  limanix first-config [PATH] [flags]

Flags:
  -h, --help   help for first-config

limanix list#

List VMs managed by Limanix.

Usage:
  limanix list [flags]

Flags:
  -h, --help   help for list
      --json   Print machine-readable JSON.

limanix modules#

Manage bundled and third-party NixOS modules.

Usage:
  limanix modules [flags]
  limanix modules [command]

Available Commands:
  add         Import a directory containing default.nix.
  list        List available module identifiers.
  remove      Remove an imported module from the catalog.

Flags:
  -h, --help   help for modules

Use "limanix modules [command] --help" for more information about a command.

limanix modules add#

Import a directory containing default.nix.

Usage:
  limanix modules add NAME DIRECTORY [flags]

Flags:
  -h, --help   help for add

limanix modules list#

List available module identifiers.

Usage:
  limanix modules list [flags]

Flags:
  -h, --help   help for list
      --json   Print machine-readable JSON.

limanix modules remove#

Remove an imported module from the catalog.

Usage:
  limanix modules remove NAME [flags]

Flags:
  -h, --help   help for remove

limanix network#

Prepare Lima's macOS networking for QEMU guests.

Usage:
  limanix network [flags]
  limanix network [command]

Available Commands:
  setup       Install the bundled socket_vmnet helper and Lima sudoers with administrator approval.

Flags:
  -h, --help   help for network

Use "limanix network [command] --help" for more information about a command.

limanix network setup#

Install the bundled socket_vmnet helper and Lima sudoers with administrator approval.

Usage:
  limanix network setup [flags]

Flags:
  -h, --help   help for setup

limanix shell#

Connect as the configured development user.

Usage:
  limanix shell NAME [-- COMMAND ...] [flags]

Flags:
  -h, --help   help for shell

limanix start#

Start an existing VM.

Usage:
  limanix start NAME [flags]

Flags:
  -h, --help   help for start

limanix stop#

Stop a VM and preserve its disk and home.

Usage:
  limanix stop NAME [flags]

Flags:
  -h, --help   help for stop

limanix update#

Apply a configuration and restart an existing VM.

Usage:
  limanix update [flags]

Flags:
      --config string   Path to the VM configuration file (required).
  -h, --help            help for update