incus-doc-cli.txt

--- Metadata ---
Content: Combination of the incus CLI documentation from the `incus --help` 
Source: Extraction of the `incus --help`
Date: 2026-03-30
Author: lxc/incus (linuxcontainers)
License: Apache-2.0
GeneratedBy: https://github.com/fruafr/incus-doc-cli
---
--- admin.md ---
# INCUS - CLI - Help - Admin

## Main command
- [`incus admin`](./incus/admin.txt)

## Sub-commands
- [`incus admin cluster`](./incus/admin/cluster.txt)
- [`incus admin init`](./incus/admin/init.txt)
- [`incus admin recover`](./incus/admin/recover.txt)
- [`incus admin shutdown`](./incus/admin/shutdown.txt)
- [`incus admin sql`](./incus/admin/sql.txt)
- [`incus admin waitready`](./incus/admin/waitready.txt)


--- cluster.md ---
# INCUS - CLI - Help - cluster

## Main command
- [`incus cluster`](./incus/cluster.txt)

## Sub-commands
- [`incus cluster add`](./incus/cluster/add.txt)
- [`incus cluster edit`](./incus/cluster/edit.txt)
- [`incus cluster enable`](./incus/cluster/enable.txt)
- [`incus cluster evacuate`](./incus/cluster/evacuate.txt)
- [`incus cluster get`](./incus/cluster/get.txt)
- [`incus cluster group`](./incus/cluster/group.txt)
- [`incus cluster info`](./incus/cluster/info.txt)
- [`incus cluster list`](./incus/cluster/list.txt)
- [`incus cluster list-tokens`](./incus/cluster/list-tokens.txt)
- [`incus cluster remove`](./incus/cluster/remove.txt)
- [`incus cluster rename`](./incus/cluster/rename.txt)
- [`incus cluster restore`](./incus/cluster/restore.txt)
- [`incus cluster revoke-token`](./incus/cluster/revoken-token.txt)
- [`incus cluster role`](./incus/cluster/role.txt)
- [`incus cluster set`](./incus/cluster/set.txt)
- [`incus cluster show`](./incus/cluster/show.txt)
- [`incus cluster update-certificate`](./incus/cluster/update-certificate.txt)


--- config.md ---
# INCUS - CLI - Help - Config

## Main command
- [`incus config`](./incus/config.txt)

## Sub-commands
- [`incus config device`](./incus/config/device.txt)
- [`incus config edit`](./incus/config/edit.txt)
- [`incus config get`](./incus/config/get.txt)
- [`incus config metadata`](./incus/config/metadata.txt)
- [`incus config set`](./incus/config/set.txt)
- [`incus config show`](./incus/config/show.txt)
- [`incus config template`](./incus/config/template.txt)
- [`incus config trust`](./incus/config/trust.txt)
- [`incus config unset`](./incus/config/unset.txt)

--- file.md ---
# INCUS - CLI - Help - File

## Main command
- [`incus file`](./incus/file.txt)

## Sub-commands
- [`incus file create`](./incus/file/create.txt)
- [`incus file delete`](./incus/file/delete.txt)
- [`incus file edit`](./incus/file/edit.txt)
- [`incus file mount`](./incus/file/mount.txt)
- [`incus file pull`](./incus/file/pull.txt)
- [`incus file push`](./incus/file/push.txt)

--- image.md ---
# INCUS - CLI - Help - Image

## Main command
- [`incus image`](./incus/image.txt)

## Sub-commands
- [`incus image alias`](./incus/image/alias.txt)
- [`incus image copy`](./incus/image/copy.txt)
- [`incus image delete`](./incus/image/delete.txt)
- [`incus image edit`](./incus/image/edit.txt)
- [`incus image export`](./incus/image/export.txt)
- [`incus image get-property`](./incus/image/get-property.txt)
- [`incus image import`](./incus/image/import.txt)
- [`incus image info`](./incus/image/info.txt)
- [`incus image list`](./incus/image/list.txt)
- [`incus image refresh`](./incus/image/refresh.txt)
- [`incus image set-property`](./incus/image/set-property.txt)
- [`incus image show`](./incus/image/show.txt)
- [`incus image unset-property`](./incus/image/unset-property.txt)

--- incus.md ---
# INCUS - CLI - Help

[Incus](https://linuxcontainers.org/incus/docs/main/) CLI help documentation

Below is the documentation of commands and sub-commands per the official command help :

- [`incus`](./incus/incus.txt)

## Main commands
- [`incus admin`](./admin.md)
- [`incus cluster`](./cluster.md)
- [`incus config`](./config.md)
- [`incus console`](./incus/console.txt)
- [`incus copy`](./incus/copy.txt)
- [`incus create`](./incus/create.txt)
- [`incus delete`](./incus/delete.txt)
- [`incus exec`](./incus/exec.txt)
- [`incus export`](./incus/export.txt)
- [`incus file`](./file.md)
- [`incus help`](./incus/help.txt)
- [`incus image`](./image.md)
- [`incus import`](./incus/import.txt)
- [`incus info`](./incus/info.txt)
- [`incus launch`](./incus/launch.txt)
- [`incus list`](./incus/list.txt)
- [`incus move`](./incus/move.txt)
- [`incus network`](./network.md)
- [`incus pause`](./incus/pause.txt)
- [`incus profile`](./profile.md)
- [`incus project`](./project.md)
- [`incus publish`](./incus/publish.txt)
- [`incus rebuild`](./incus/rebuild.txt)
- [`incus remote`](./remote.md)
- [`incus rename`](./incus/rename.txt)
- [`incus restart`](./incus/restart.txt)
- [`incus resume`](./incus/resume.txt)
- [`incus snapshot`](./snapshot.md)
- [`incus start`](./incus/start.txt)
- [`incus stop`](./incus/stop.txt)
- [`incus storage`](./storage.md)
- [`incus top`](./incus/top.txt)
- [`incus version`](./incus/version.txt)
- [`incus webui`](./incus/webui.txt)

--- network.md ---
# INCUS - CLI - Help - Network

## Main command
- [`incus network`](./incus/network.txt)

## Sub-commands
- [`incus network acl`](./incus/network/acl.txt)
- [`incus network attach`](./incus/network/attach.txt)
- [`incus network attach-profile`](./incus/network/attach-profile.txt)
- [`incus network create`](./incus/network/create.txt)
- [`incus network delete`](./incus/network/delete.txt)
- [`incus network detach`](./incus/network/detach.txt)
- [`incus network detach-profile`](./incus/network/detach-profile.txt)
- [`incus network edit`](./incus/network/edit.txt)
- [`incus network forward`](./incus/network/forward.txt)
- [`incus network get`](./incus/network/get.txt)
- [`incus network info`](./incus/network/info.txt)
- [`incus network integration`](./incus/network/integration.txt)
- [`incus network list`](./incus/network/list.txt)
- [`incus network list-allocations`](./incus/network/list-allocations.txt)
- [`incus network list-leases`](./incus/network/list-leases.txt)
- [`incus network load-balancer`](./incus/network/load-balancer.txt)
- [`incus network peer`](./incus/network/peer.txt)
- [`incus network rename`](./incus/network/rename.txt)
- [`incus network set`](./incus/network/set.txt)
- [`incus network show`](./incus/network/show.txt)
- [`incus network unset`](./incus/network/unset.txt)
- [`incus network zone`](./incus/network/zone.txt)

--- profile.md ---
# INCUS - CLI - Help - Profile

## Main command
- [`incus profile`](./incus/profile.txt)

## Sub-commands
- [`incus profile add`](./incus/profile/add.txt)
- [`incus profile assign`](./incus/profile/assign.txt)
- [`incus profile copy`](./incus/profile/copy.txt)
- [`incus profile create`](./incus/profile/create.txt)
- [`incus profile delete`](./incus/profile/delete.txt)
- [`incus profile device`](./incus/profile/device.txt)
- [`incus profile edit`](./incus/profile/edit.txt)
- [`incus profile get`](./incus/profile/get.txt)
- [`incus profile list`](./incus/profile/list.txt)
- [`incus profile remove`](./incus/profile/remove.txt)
- [`incus profile rename`](./incus/profile/rename.txt)
- [`incus profile set`](./incus/profile/set.txt)
- [`incus profile show`](./incus/profile/show.txt)
- [`incus profile unset`](./incus/profile/unset.txt)

--- project.md ---
# INCUS - CLI - Help - Project

## Main command
- [`incus project`](./incus/project.txt)

## Sub-commands
- [`incus project create`](./incus/project/create.txt)
- [`incus project delete`](./incus/project/delete.txt)
- [`incus project edit`](./incus/project/edit.txt)
- [`incus project get`](./incus/project/get.txt)
- [`incus project get-current`](./incus/project/get-current.txt)
- [`incus project info`](./incus/project/info.txt)
- [`incus project list`](./incus/project/list.txt)
- [`incus project rename`](./incus/project/rename.txt)
- [`incus project set`](./incus/project/set.txt)
- [`incus project show`](./incus/project/show.txt)
- [`incus project switch`](./incus/project/switch.txt)
- [`incus project unset`](./incus/project/unset.txt)

--- remote.md ---
# INCUS - CLI - Help - Remote

## Main command
- [`incus remote`](./incus/remote.txt)

## Sub-commands
- [`incus remote add`](./incus/remote/add.txt)
- [`incus remote generate-certificate`](./incus/remote/generate-certificate.txt)
- [`incus remote get-default`](./incus/remote/get-default.txt)
- [`incus remote list`](./incus/remote/list.txt)
- [`incus remote proxy`](./incus/remote/proxy.txt)
- [`incus remote remove`](./incus/remote/remove.txt)
- [`incus remote rename`](./incus/remote/rename.txt)
- [`incus remote set-url`](./incus/remote/set-url.txt)
- [`incus remote switch`](./incus/remote/switch.txt)

--- snapshot.md ---
# INCUS - CLI - Help - Snapshot

## Main command
- [`incus snapshot`](./incus/snapshot.txt)

## Sub-commands
- [`incus snapshot create`](./incus/snapshot/create.txt)
- [`incus snapshot delete`](./incus/snapshot/delete.txt)
- [`incus snapshot list`](./incus/snapshot/list.txt)
- [`incus snapshot rename`](./incus/snapshot/rename.txt)
- [`incus snapshot restore`](./incus/snapshot/restore.txt)
- [`incus snapshot show`](./incus/snapshot/show.txt)

--- storage.md ---
# INCUS - CLI - Help - Storage

## Main command
- [`incus storage`](./incus/storage.txt)

## Sub-commands
- [`incus storage bucket`](./incus/storage/bucket.txt)
- [`incus storage create`](./incus/storage/create.txt)
- [`incus storage delete`](./incus/storage/delete.txt)
- [`incus storage edit`](./incus/storage/edit.txt)
- [`incus storage get`](./incus/storage/get.txt)
- [`incus storage info`](./incus/storage/info.txt)
- [`incus storage list`](./incus/storage/list.txt)
- [`incus storage set`](./incus/storage/set.txt)
- [`incus storage show`](./incus/storage/show.txt)
- [`incus storage unset`](./incus/storage/unset.txt)
- [`incus storage volume`](./incus/storage/volume.txt)

--- admin.txt ---
Description:
  Manage incus daemon

Usage:
  incus admin [command]

Available Commands:
  cluster     Low-level cluster administration commands
  init        Configure the daemon
  recover     Recover missing instances and volumes from existing and unknown storage pools
  shutdown    Tell the daemon to shutdown all instances and exit
  sql         Execute a SQL query against the local or global database
  waitready   Wait for the daemon to be ready to process requests

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- cluster.txt ---
Description:
  Manage cluster members

Usage:
  incus cluster [flags]
  incus cluster [command]

Available Commands:
  add                Request a join token for adding a cluster member
  edit               Edit cluster member configurations as YAML
  enable             Enable clustering on a single non-clustered server
  evacuate           Evacuate cluster member
  get                Get values for cluster member configuration keys
  group              Manage cluster groups
  info               Show useful information about a cluster member
  list               List all the cluster members
  list-tokens        List all active cluster member join tokens
  remove             Remove a member from the cluster
  rename             Rename a cluster member
  restore            Restore cluster member
  revoke-token       Revoke cluster member join token
  role               Manage cluster roles
  set                Set a cluster member's configuration keys
  show               Show details of a cluster member
  unset              Unset a cluster member's configuration keys
  update-certificate Update cluster certificate

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- config.txt ---
Description:
  Manage instance and server configuration options

Usage:
  incus config [flags]
  incus config [command]

Available Commands:
  device      Manage devices
  edit        Edit instance or server configurations as YAML
  get         Get values for instance or server configuration keys
  metadata    Manage instance metadata files
  set         Set instance or server configuration keys
  show        Show instance or server configurations
  template    Manage instance file templates
  trust       Manage trusted clients
  unset       Unset instance or server configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- console.txt ---
Description:
  Attach to instance consoles

  This command allows you to interact with the boot console of an instance
  as well as retrieve past log entries from it.

Usage:
  incus console [<remote>:]<instance> [flags]

Flags:
  -f, --force      Forces a connection to the console, even if there is already an active session
      --show-log   Retrieve the instance's console log
  -t, --type       Type of connection to establish: 'console' for serial console, 'vga' for SPICE graphical output (default "console")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- copy.txt ---
Description:
  Copy instances within or in between servers

  Transfer modes (--mode):
   - pull: Target server pulls the data from the source server (source must listen on network)
   - push: Source server pushes the data to the target server (target must listen on network)
   - relay: The CLI connects to both source and server and proxies the data (both source and target must listen on network)

  The pull transfer mode is the default as it is compatible with all server versions.

Usage:
  incus copy [<remote>:]<source>[/<snapshot>] [[<remote>:]<destination>] [flags]

Aliases:
  copy, cp

Flags:
      --allow-inconsistent      Ignore copy errors for volatile files
  -c, --config                  Config key/value to apply to the new instance
  -d, --device                  New key/value to apply to a specific device
  -e, --ephemeral               Ephemeral instance
      --instance-only           Copy the instance without its snapshots
      --mode                    Transfer mode. One of pull, push or relay (default "pull")
      --no-profiles             Create the instance with no profiles applied
  -p, --profile                 Profile to apply to the new instance
      --refresh                 Perform an incremental copy
      --refresh-exclude-older   During incremental copy, exclude source snapshots earlier than latest target snapshot
      --stateless               Copy a stateful instance stateless
  -s, --storage                 Storage pool name
      --target                  Cluster member name
      --target-project          Copy to a project different from the source

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- create.txt ---
Description:
  Create instances from images

Usage:
  incus create [<remote>:]<image> [<remote>:][<name>] [flags]

Aliases:
  create, init

Examples:
  incus create images:ubuntu/22.04 u1

  incus create images:ubuntu/22.04 u1 < config.yaml
      Create the instance with configuration from config.yaml

  incus launch images:debian/12 v2 --vm -d root,size=50GiB -d root,io.bus=nvme
      Create and start a virtual machine, overriding the disk size and bus

Flags:
  -c, --config             Config key/value to apply to the new instance
      --description        Instance description
  -d, --device             New key/value to apply to a specific device
      --empty              Create an empty instance
      --environment-file   Include environment variables from file
  -e, --ephemeral          Ephemeral instance
  -n, --network            Network name
      --no-profiles        Create the instance with no profiles applied
  -p, --profile            Profile to apply to the new instance
  -s, --storage            Storage pool name
      --target             Cluster member name
  -t, --type               Instance type
      --vm                 Create a virtual machine

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete instances

Usage:
  incus delete [<remote>:]<instance> [[<remote>:]<instance>...] [flags]

Aliases:
  delete, rm

Flags:
  -f, --force         Force the removal of running instances
  -i, --interactive   Require user confirmation

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- exec.txt ---
Description:
  Execute commands in instances

  The command is executed directly using exec, so there is no shell and
  shell patterns (variables, file redirects, ...) won't be understood.
  If you need a shell environment you need to execute the shell
  executable, passing the shell commands as arguments, for example:

    incus exec <instance> -- sh -c "cd /tmp && pwd"

  Mode defaults to non-interactive, interactive mode is selected if both stdin AND stdout are terminals (stderr is ignored).

Usage:
  incus exec [<remote>:]<instance> [flags] [--] <command line>

Examples:
  incus exec c1 bash
  	Run the "bash" command in instance "c1"

  incus exec c1 -- ls -lh /
  	Run the "ls -lh /" command in instance "c1"

Flags:
      --cwd                    Directory to run the command in (default /root)
  -n, --disable-stdin          Disable stdin (reads from /dev/null)
      --env                    Environment variable to set (e.g. HOME=/home/foo)
  -t, --force-interactive      Force pseudo-terminal allocation
  -T, --force-noninteractive   Disable pseudo-terminal allocation
      --group                  Group ID to run the command as (default 0)
      --mode                   Override the terminal mode (auto, interactive or non-interactive) (default "auto")
      --user                   User ID to run the command as (default 0)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- export.txt ---
Description:
  Export instances as backup tarballs.

Usage:
  incus export [<remote>:]<instance> [target] [--instance-only] [--optimized-storage] [flags]

Examples:
  incus export u1 backup0.tar.gz
      Download a backup tarball of the u1 instance.

Flags:
      --compression         Compression algorithm to use (none for uncompressed)
      --instance-only       Whether or not to only backup the instance (without snapshots)
      --optimized-storage   Use storage driver optimized format (can only be restored on a similar pool)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- file.txt ---
Description:
  Manage files in instances

Usage:
  incus file [flags]
  incus file [command]

Available Commands:
  create      Create files and directories in instances
  delete      Delete files in instances
  edit        Edit files in instances
  mount       Mount files from instances
  pull        Pull files from instances
  push        Push files into instances

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- help.txt ---
Help provides help for any command in the application.
Simply type incus help [path to command] for full details.

Usage:
  incus help [command] [flags]

Flags:
      --all   Show less common commands

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- image.txt ---
Description:
  Manage images

  Instances are created from images. Those images were themselves
  either generated from an existing instance or downloaded from an image
  server.

  When using remote images, the server will automatically cache images for you
  and remove them upon expiration.

  The image unique identifier is the hash (sha-256) of its representation
  as a compressed tarball (or for split images, the concatenation of the
  metadata and rootfs tarballs).

  Images can be referenced by their full hash, shortest unique partial
  hash or alias name (if one is set).

Usage:
  incus image [flags]
  incus image [command]

Available Commands:
  alias          Manage image aliases
  copy           Copy images between servers
  delete         Delete images
  edit           Edit image properties
  export         Export and download images
  get-property   Get image properties
  import         Import images into the image store
  info           Show useful information about images
  list           List images
  refresh        Refresh images
  set-property   Set image properties
  show           Show image properties
  unset-property Unset image properties

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- import.txt ---
Description:
  Import backups of instances including their snapshots.

Usage:
  incus import [<remote>:] <backup file> [<instance name>] [flags]

Examples:
  incus import backup0.tar.gz
      Create a new instance using backup0.tar.gz as the source.

Flags:
  -s, --storage   Storage pool name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- incus.txt ---
Description:
  Command line client for Incus

  All of Incus's features can be driven through the various commands below.
  For help with any of those, simply call them with --help.

  Custom commands can be defined through aliases, use "incus alias" to control those.

Usage:
  incus [command]

Available Commands:
  admin       Manage incus daemon
  cluster     Manage cluster members
  config      Manage instance and server configuration options
  console     Attach to instance consoles
  copy        Copy instances within or in between servers
  create      Create instances from images
  delete      Delete instances
  exec        Execute commands in instances
  export      Export instance backups
  file        Manage files in instances
  help        Help about any command
  image       Manage images
  import      Import instance backups
  info        Show instance or server information
  launch      Create and start instances from images
  list        List instances
  move        Move instances within or in between servers
  network     Manage and attach instances to networks
  pause       Pause instances
  profile     Manage profiles
  project     Manage projects
  publish     Publish instances as images
  rebuild     Rebuild instances
  remote      Manage the list of remote servers
  rename      Rename instances
  restart     Restart instances
  resume      Resume instances
  snapshot    Manage instance snapshots
  start       Start instances
  stop        Stop instances
  storage     Manage storage pools and volumes
  top         Display resource usage info per instance
  version     Show local and remote versions
  webui       Open the web interface

Flags:
      --all            Show less common commands
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- info.txt ---
Description:
  Show instance or server information

Usage:
  incus info [<remote>:][<instance>] [flags]

Examples:
  incus info [<remote>:]<instance> [--show-log]
      For instance information.

  incus info [<remote>:] [--resources]
      For server information.

Flags:
      --resources     Show the resources available to the server
      --show-access   Show the instance's access list
      --show-log      Show the instance's recent log entries
      --target        Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- launch.txt ---
Description:
  Create and start instances from images

Usage:
  incus launch [<remote>:]<image> [<remote>:][<name>] [flags]

Aliases:
  launch, init

Examples:
  incus launch images:ubuntu/22.04 u1

  incus launch images:ubuntu/22.04 u1 < config.yaml
      Create and start a container with configuration from config.yaml

  incus launch images:ubuntu/22.04 u2 -t aws:t2.micro
      Create and start a container using the same size as an AWS t2.micro (1 vCPU, 1GiB of RAM)

  incus launch images:ubuntu/22.04 v1 --vm -c limits.cpu=4 -c limits.memory=4GiB
      Create and start a virtual machine with 4 vCPUs and 4GiB of RAM

  incus launch images:debian/12 v2 --vm -d root,size=50GiB -d root,io.bus=nvme
      Create and start a virtual machine, overriding the disk size and bus

Flags:
  -c, --config                Config key/value to apply to the new instance
      --console[="console"]   Immediately attach to the console
      --description           Instance description
  -d, --device                New key/value to apply to a specific device
      --empty                 Create an empty instance
      --environment-file      Include environment variables from file
  -e, --ephemeral             Ephemeral instance
  -n, --network               Network name
      --no-profiles           Create the instance with no profiles applied
  -p, --profile               Profile to apply to the new instance
  -s, --storage               Storage pool name
      --target                Cluster member name
  -t, --type                  Instance type
      --vm                    Create a virtual machine

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List instances

  Default column layout: ns46tS
  Fast column layout: nsacPt

  A single keyword like "web" which will list any instance with a name starting by "web".
  A regular expression on the instance name. (e.g. .*web.*01$).
  A key/value pair referring to a configuration item. For those, the
  namespace can be abbreviated to the smallest unambiguous identifier.
  A key/value pair where the key is a shorthand. Multiple values must be delimited by ','. Available shorthands:
    - type={instance type}
    - status={instance current lifecycle status}
    - architecture={instance architecture}
    - location={location name}
    - ipv4={ip or CIDR}
    - ipv6={ip or CIDR}

  Examples:
    - "user.blah=abc" will list all instances with the "blah" user property set to "abc".
    - "u.blah=abc" will do the same
    - "security.privileged=true" will list all privileged instances
    - "s.privileged=true" will do the same
    - "type=container" will list all container instances
    - "type=container status=running" will list all running container instances

  A regular expression matching a configuration item or its value. (e.g. volatile.eth0.hwaddr=10:66:6a:.*).

  When multiple filters are passed, they are added one on top of the other,
  selecting instances which satisfy them all.

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which instance attributes to output when displaying in table or csv
  format.

  Column arguments are either pre-defined shorthand chars (see below),
  or (extended) config keys.

  Commas between consecutive shorthand chars are optional.

  Pre-defined column shorthand chars:
    4 - IPv4 address
    6 - IPv6 address
    a - Architecture
    b - Storage pool
    c - Creation date
    d - Description
    D - disk usage
    e - Project name
    l - Last used date
    m - Memory usage
    M - Memory usage (%)
    n - Name
    N - Number of Processes
    p - PID of the instance's init process
    P - Profiles
    s - State
    S - Number of snapshots
    t - Type (persistent or ephemeral)
    u - CPU usage (in seconds)
    U - Started date
    L - Location of the instance (e.g. its cluster member)
    f - Base Image Fingerprint (short)
    F - Base Image Fingerprint (long)

  Custom columns are defined with "[config:|devices:]key[:name][:maxWidth]":
    KEY: The (extended) config or devices key to display. If [config:|devices:] is omitted then it defaults to config key.
    NAME: Name to display in the column header.
    Defaults to the key if not specified or empty.

    MAXWIDTH: Max width of the column (longer results are truncated).
    Defaults to -1 (unlimited). Use 0 to limit to the column header size.

Usage:
  incus list [<remote>:] [<filter>...] [flags]

Aliases:
  list, ls

Examples:
  incus list -c nFs46,volatile.eth0.hwaddr:MAC,config:image.os,devices:eth0.parent:ETHP
    Show instances using the "NAME", "BASE IMAGE", "STATE", "IPV4", "IPV6" and "MAC" columns.
    "BASE IMAGE", "MAC" and "IMAGE OS" are custom columns generated from instance configuration keys.
    "ETHP" is a custom column generated from a device key.

  incus list -c ns,user.comment:comment
    List instances with their running state and user comment.

Flags:
      --all-projects   Display instances from all projects
  -c, --columns        Columns (default "ns46tSL")
      --fast           Fast mode (same as --columns=nsacPt)
  -f, --format         Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- move.txt ---
Description:
  Move instances within or in between servers

  Transfer modes (--mode):
   - pull: Target server pulls the data from the source server (source must listen on network)
   - push: Source server pushes the data to the target server (target must listen on network)
   - relay: The CLI connects to both source and server and proxies the data (both source and target must listen on network)

  The pull transfer mode is the default as it is compatible with all server versions.

Usage:
  incus move [<remote>:]<instance> [<remote>:][<instance>] [flags]

Aliases:
  move, mv

Examples:
  incus move [<remote>:]<source instance> [<remote>:][<destination instance>] [--instance-only]
      Move an instance between two hosts, renaming it if destination name differs.

  incus move <old name> <new name> [--instance-only]
      Rename a local instance.

  incus move <instance>/<old snapshot name> <instance>/<new snapshot name>
      Rename a snapshot.

Flags:
      --allow-inconsistent   Ignore copy errors for volatile files
  -c, --config               Config key/value to apply to the target instance
  -d, --device               New key/value to apply to a specific device
      --instance-only        Move the instance without its snapshots
      --mode                 Transfer mode. One of pull, push or relay. (default "pull")
      --no-profiles          Unset all profiles on the target instance
  -p, --profile              Profile to apply to the target instance
      --stateless            Copy a stateful instance stateless
  -s, --storage              Storage pool name
      --target               Cluster member name
      --target-project       Copy to a project different from the source

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- network.txt ---
Description:
  Manage and attach instances to networks

Usage:
  incus network [flags]
  incus network [command]

Available Commands:
  acl              Manage network ACLs
  attach           Attach network interfaces to instances
  attach-profile   Attach network interfaces to profiles
  create           Create new networks
  delete           Delete networks
  detach           Detach network interfaces from instances
  detach-profile   Detach network interfaces from profiles
  edit             Edit network configurations as YAML
  forward          Manage network forwards
  get              Get values for network configuration keys
  info             Get runtime information on networks
  integration      Manage network integrations
  list             List available networks
  list-allocations List network allocations in use
  list-leases      List DHCP leases
  load-balancer    Manage network load balancers
  peer             Manage network peerings
  rename           Rename networks
  set              Set network configuration keys
  show             Show network configurations
  unset            Unset network configuration keys
  zone             Manage network zones

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- pause.txt ---
Description:
  Pause instances

Usage:
  incus pause [<remote>:]<instance> [[<remote>:]<instance>...] [flags]

Aliases:
  pause, freeze

Flags:
      --all   Run against all instances

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- profile.txt ---
Description:
  Manage profiles

Usage:
  incus profile [flags]
  incus profile [command]

Available Commands:
  add         Add profiles to instances
  assign      Assign sets of profiles to instances
  copy        Copy profiles
  create      Create profiles
  delete      Delete profiles
  device      Manage devices
  edit        Edit profile configurations as YAML
  get         Get values for profile configuration keys
  list        List profiles
  remove      Remove profiles from instances
  rename      Rename profiles
  set         Set profile configuration keys
  show        Show profile configurations
  unset       Unset profile configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- project.txt ---
Description:
  Manage projects

Usage:
  incus project [flags]
  incus project [command]

Available Commands:
  create      Create projects
  delete      Delete projects
  edit        Edit project configurations as YAML
  get         Get values for project configuration keys
  get-current Show the current project
  info        Get a summary of resource allocations
  list        List projects
  rename      Rename projects
  set         Set project configuration keys
  show        Show project options
  switch      Switch the current project
  unset       Unset project configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- publish.txt ---
Description:
  Publish instances as images

Usage:
  incus publish [<remote>:]<instance>[/<snapshot>] [<remote>:] [flags] [key=value...]

Flags:
      --alias              New alias to define at target
      --compression none   Compression algorithm to use (none for uncompressed)
      --expire             Image expiration date (format: rfc3339)
  -f, --force              Stop the instance if currently running
      --public             Make the image public
      --reuse              If the image alias already exists, delete and create a new one

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- rebuild.txt ---
Description:
  Wipe the instance root disk and re-initialize with a new image (or empty volume).

Usage:
  incus rebuild [<remote>:]<image> [<remote>:]<instance> [flags]

Flags:
      --empty   Rebuild as an empty instance
  -f, --force   If an instance is running, stop it and then rebuild it

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- remote.txt ---
Description:
  Manage the list of remote servers

Usage:
  incus remote [flags]
  incus remote [command]

Available Commands:
  add                  Add new remote servers
  generate-certificate Generate the client certificate
  get-default          Show the default remote
  list                 List the available remotes
  proxy                Run a local API proxy
  remove               Remove remotes
  rename               Rename remotes
  set-url              Set the URL for the remote
  switch               Switch the default remote

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- rename.txt ---
Description:
  Rename instances

Usage:
  incus rename [<remote>:]<instance> <instance> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- restart.txt ---
Description:
  Restart instances

Usage:
  incus restart [<remote>:]<instance> [[<remote>:]<instance>...] [flags]

Flags:
      --all                   Run against all instances
      --console[="console"]   Immediately attach to the console
  -f, --force                 Force the instance to stop
      --timeout               Time to wait for the instance to shutdown cleanly (default -1)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- resume.txt ---
Description:
  Resume instances

Usage:
  incus resume [<remote>:]<instance> [[<remote>:]<instance>...] [flags]

Aliases:
  resume, unfreeze

Flags:
      --all   Run against all instances

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- snapshot.txt ---
Description:
  Manage instance snapshots

Usage:
  incus snapshot [flags]
  incus snapshot [command]

Available Commands:
  create      Create instance snapshot
  delete      Delete instance snapshots
  list        List instance snapshots
  rename      Rename instance snapshots
  restore     Restore instance snapshots
  show        Show instance snapshot configuration

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- start.txt ---
Description:
  Start instances

Usage:
  incus start [<remote>:]<instance> [[<remote>:]<instance>...] [flags]

Flags:
      --all                   Run against all instances
      --console[="console"]   Immediately attach to the console
      --stateless             Ignore the instance state

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- stop.txt ---
Description:
  Stop instances

Usage:
  incus stop [<remote>:]<instance> [[<remote>:]<instance>...] [flags]

Flags:
      --all                   Run against all instances
      --console[="console"]   Immediately attach to the console
  -f, --force                 Force the instance to stop
      --stateful              Store the instance state
      --timeout               Time to wait for the instance to shutdown cleanly (default -1)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- storage.txt ---
Description:
  Manage storage pools and volumes

Usage:
  incus storage [flags]
  incus storage [command]

Available Commands:
  bucket      Manage storage buckets
  create      Create storage pools
  delete      Delete storage pools
  edit        Edit storage pool configurations as YAML
  get         Get values for storage pool configuration keys
  info        Show useful information about storage pools
  list        List available storage pools
  set         Set storage pool configuration keys
  show        Show storage pool configurations and resources
  unset       Unset storage pool configuration keys
  volume      Manage storage volumes

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- top.txt ---
Description:
  Displays CPU usage, memory usage, and disk usage per instance

  Default column layout: numD

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which instance attributes to output when displaying in table or compact
  format.

  Column arguments are pre-defined shorthand chars (see below).
  Commas between consecutive shorthand chars are optional.

  Column shorthand chars:
    D - disk usage
    e - Project name
    m - Memory usage
    n - Instance name
    u - CPU usage (in seconds)

Usage:
  incus top [<remote>:] [flags]

Flags:
      --all-projects   Display instances from all projects
  -c, --columns        Columns (default "numD")
  -f, --format         Format (table|compact) (default "table")
      --refresh        Configure the refresh delay in seconds (default 10)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- version.txt ---
Description:
  Show local and remote versions

Usage:
  incus version [<remote>:] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- webui.txt ---
Description:
  Open the web interface

Usage:
  incus webui [<remote>:] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- cluster.txt ---
Description:
  Low level administration tools for inspecting and recovering clusters.

Usage:
  incus admin cluster [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- init.txt ---
Description:
  Configure the daemon

Usage:
  incus admin init [flags]

Examples:
  init --minimal
  init --auto [--network-address=IP] [--network-port=8443] [--storage-backend=dir]
              [--storage-create-device=DEVICE] [--storage-create-loop=SIZE]
              [--storage-pool=POOL]
  init --preseed
  init --dump


Flags:
      --auto                    Automatic (non-interactive) mode
      --dump                    Dump YAML config to stdout
      --minimal                 Minimal configuration (non-interactive)
      --network-address         Address to bind to (default: none)
      --network-port            Port to bind to (default: 8443) (default -1)
      --preseed                 Pre-seed mode, expects YAML config from stdin
      --storage-backend         Storage backend to use (btrfs, dir, lvm or zfs, default: dir)
      --storage-create-device   Setup device based storage using DEVICE
      --storage-create-loop     Setup loop based storage with SIZE in GiB (default -1)
      --storage-pool            Storage pool to use or create

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- recover.txt ---
Description:
  Recover missing instances and volumes from existing and unknown storage pools

    This command is mostly used for disaster recovery. It will ask you about unknown storage pools and attempt to
    access them, along with existing storage pools, and identify any missing instances and volumes that exist on the
    pools but are not in the database. It will then offer to recreate these database records.

Usage:
  incus admin recover [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- shutdown.txt ---
Description:
  Tell the daemon to shutdown all instances and exit

    This will tell the daemon to start a clean shutdown of all instances,
    followed by having itself shutdown and exit.

    This can take quite a while as instances can take a long time to
    shutdown, especially if a non-standard timeout was configured for them.

Usage:
  incus admin shutdown [flags]

Flags:
  -f, --force     Force shutdown instead of waiting for running operations to finish
  -t, --timeout   Number of seconds to wait before giving up

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- sql.txt ---
Description:
  Execute a SQL query against the local or global database

    The local database is specific to the cluster member you target the
    command to, and contains member-specific data (such as the member network
    address).

    The global database is common to all members in the cluster, and contains
    cluster-specific data (such as profiles, containers, etc).

    If you are running a non-clustered server, the same applies, as that
    instance is effectively a single-member cluster.

    If <query> is the special value "-", then the query is read from
    standard input.

    If <query> is the special value ".dump", the command returns a SQL text
    dump of the given database.

    If <query> is the special value ".schema", the command returns the SQL
    text schema of the given database.

    This internal command is mostly useful for debugging and disaster
    recovery. The development team will occasionally provide hotfixes to users as a
    set of database queries to fix some data inconsistency.

Usage:
  incus admin sql <local|global> <query> [flags]

Flags:
  -f, --format   Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- waitready.txt ---
Description:
  Wait for the daemon to be ready to process requests

    This command will block until the daemon is reachable over its REST API and
    is done with early start tasks like re-starting previously started
    containers.

Usage:
  incus admin waitready [flags]

Flags:
  -t, --timeout   Number of seconds to wait before giving up

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- add.txt ---
Description:
  Request a join token for adding a cluster member

Usage:
  incus cluster add [[<remote>:]<member>] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- edit.txt ---
Description:
  Edit cluster member configurations as YAML

Usage:
  incus cluster edit [<remote>:]<member> [flags]

Examples:
  incus cluster edit <cluster member> < member.yaml
      Update a cluster member using the content of member.yaml

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- enable.txt ---
Description:
  Enable clustering on a single non-clustered server

    This command turns a non-clustered server into the first member of a new
    cluster, which will have the given name.

    It's required that the server is already available on the network. You can check
    that by running 'incus config get core.https_address', and possibly set a value
    for the address if not yet set.

Usage:
  incus cluster enable [<remote>:] <name> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- evacuate.txt ---
Description:
  Evacuate cluster member

Usage:
  incus cluster evacuate [<remote>:]<member> [flags]

Aliases:
  evacuate, evac

Flags:
      --action   Force a particular evacuation action
      --force    Force evacuation without user confirmation

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get.txt ---
Description:
  Get values for cluster member configuration keys

Usage:
  incus cluster get [<remote>:]<member> <key> [flags]

Flags:
  -p, --property   Get the key as a cluster property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- group.txt ---
Description:
  Manage cluster groups

Usage:
  incus cluster group [command]

Available Commands:
  add         Add member to group
  assign      Assign sets of groups to cluster members
  create      Create a cluster group
  delete      Delete a cluster group
  edit        Edit a cluster group
  list        List all the cluster groups
  remove      Remove member from group
  rename      Rename a cluster group
  show        Show cluster group configurations

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus cluster group [command] --help" for more information about a command.

--- info.txt ---
Description:
  Show useful information about a cluster member

Usage:
  incus cluster info [<remote>:]<member> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list-tokens.txt ---
Description:
  List all active cluster member join tokens

  Default column layout: nte

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which network zone attributes to output when displaying in table or csv
  format.

  Column arguments are either pre-defined shorthand chars (see below),
  or (extended) config keys.

  Commas between consecutive shorthand chars are optional.

  Pre-defined column shorthand chars:
    n - Name
    t - Token
    E - Expires At

Usage:
  incus cluster list-tokens [<remote>:] [flags]

Flags:
  -c, --columns   Columns (default "ntE")
  -f, --format    Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable if demanded, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List all the cluster members

  	The -c option takes a (optionally comma-separated) list of arguments
  	that control which image attributes to output when displaying in table
  	or csv format.

  	Default column layout is: nurafdsm

  	Column shorthand chars:

      n - Server name
      u - URL
      r - Roles
      a - Architecture
      f - Failure Domain
      d - Description
      s - Status
      m - Message

Usage:
  incus cluster list [<remote>:] [flags]

Aliases:
  list, ls

Flags:
      --all-projects   Display clusters from all projects
  -c, --columns        Columns (default "nurafdsm")
  -f, --format         Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- remove.txt ---
Description:
  Remove a member from the cluster

Usage:
  incus cluster remove [<remote>:]<member> [flags]

Aliases:
  remove, rm

Flags:
  -f, --force   Force removing a member, even if degraded
      --yes     Don't require user confirmation for using --force

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- rename.txt ---
Description:
  Rename a cluster member

Usage:
  incus cluster rename [<remote>:]<member> <new-name> [flags]

Aliases:
  rename, mv

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- restore.txt ---
Description:
  Restore cluster member

Usage:
  incus cluster restore [<remote>:]<member> [flags]

Flags:
      --force   Force evacuation without user confirmation

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- revoken-token.txt ---
Description:
  Revoke cluster member join token

Usage:
  incus cluster revoke-token [<remote>:]<member> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- role.txt ---
Description:
  Manage cluster roles

Usage:
  incus cluster role [flags]
  incus cluster role [command]

Available Commands:
  add         Add roles to a cluster member
  remove      Remove roles from a cluster member

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus cluster role [command] --help" for more information about a command.

--- set.txt ---
Description:
  Set a cluster member's configuration keys

Usage:
  incus cluster set [<remote>:]<member> <key>=<value>... [flags]

Flags:
  -p, --property   Set the key as a cluster property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show details of a cluster member

Usage:
  incus cluster show [<remote>:]<member> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- update-certificate.txt ---
Description:
  Update cluster certificate with PEM certificate and key read from input files.

Usage:
  incus cluster update-certificate [<remote>:] <cert.crt> <cert.key> [flags]

Aliases:
  update-certificate, update-cert

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- device.txt ---
Description:
  Manage devices

Usage:
  incus config device [flags]
  incus config device [command]

Available Commands:
  add         Add instance devices
  get         Get values for device configuration keys
  list        List instance devices
  override    Copy profile inherited devices and override configuration keys
  remove      Remove instance devices
  set         Set device configuration keys
  show        Show full device configuration
  unset       Unset device configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus config device [command] --help" for more information about a command.

--- edit.txt ---
Description:
  Edit instance or server configurations as YAML

Usage:
  incus config edit [<remote>:][<instance>[/<snapshot>]] [flags]

Examples:
  incus config edit <instance> < instance.yaml
      Update the instance configuration from config.yaml.

Flags:
      --target   Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get.txt ---
Description:
  Get values for instance or server configuration keys

Usage:
  incus config get [<remote>:][<instance>] <key> [flags]

Flags:
  -e, --expanded   Access the expanded configuration
  -p, --property   Get the key as an instance property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- metadata.txt ---
Description:
  Manage instance metadata files

Usage:
  incus config metadata [flags]
  incus config metadata [command]

Available Commands:
  edit        Edit instance metadata files
  show        Show instance metadata files

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus config metadata [command] --help" for more information about a command.

--- set.txt ---
Description:
  Set instance or server configuration keys

  For backward compatibility, a single configuration key may still be set with:
      incus config set [<remote>:][<instance>] <key> <value>

Usage:
  incus config set [<remote>:][<instance>] <key>=<value>... [flags]

Examples:
  incus config set [<remote>:]<instance> limits.cpu=2
      Will set a CPU limit of "2" for the instance.

  incus config set core.https_address=[::]:8443
      Will have the server listen on IPv4 and IPv6 port 8443.

Flags:
  -p, --property   Set the key as an instance property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show instance or server configurations

Usage:
  incus config show [<remote>:][<instance>[/<snapshot>]] [flags]

Flags:
  -e, --expanded   Show the expanded configuration
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- template.txt ---
Description:
  Manage instance file templates

Usage:
  incus config template [flags]
  incus config template [command]

Available Commands:
  create      Create new instance file templates
  delete      Delete instance file templates
  edit        Edit instance file templates
  list        List instance file templates
  show        Show content of instance file templates

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus config template [command] --help" for more information about a command.

--- trust.txt ---
Description:
  Manage trusted clients

Usage:
  incus config trust [flags]
  incus config trust [command]

Available Commands:
  add             Add new trusted client
  add-certificate Add new trusted client certificate
  edit            Edit trust configurations as YAML
  list            List trusted clients
  list-tokens     List all active certificate add tokens
  remove          Remove trusted client
  revoke-token    Revoke certificate add token
  show            Show trust configurations

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus config trust [command] --help" for more information about a command.

--- unset.txt ---
Description:
  Unset instance or server configuration keys

Usage:
  incus config unset [<remote>:][<instance>] <key> [flags]

Flags:
  -p, --property   Unset the key as an instance property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- create.txt ---
Description:
  Create files and directories in instances

Usage:
  incus file create [<remote>:]<instance>/<path> [<symlink target path>] [flags]

Examples:
  incus file create foo/bar
  	   To create a file /bar in the foo instance.
  incus file create --type=symlink foo/bar baz
  	   To create a symlink /bar in instance foo whose target is baz.

Flags:
  -p, --create-dirs   Create any directories necessary
  -f, --force         Force creating files or directories
      --gid           Set the file's gid on create (default -1)
      --mode          Set the file's perms on create
      --type          The type to create (file, symlink, or directory) (default "file")
      --uid           Set the file's uid on create (default -1)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete files in instances

Usage:
  incus file delete [<remote>:]<instance>/<path> [[<remote>:]<instance>/<path>...] [flags]

Aliases:
  delete, rm

Flags:
  -f, --force   Force deleting files, directories, and subdirectories

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- edit.txt ---
Description:
  Edit files in instances

Usage:
  incus file edit [<remote>:]<instance>/<path> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- mount.txt ---
Description:
  Mount files from instances

Usage:
  incus file mount [<remote>:]<instance>[/<path>] [<target path>] [flags]

Examples:
  incus file mount foo/root fooroot
     To mount /root from the instance foo onto the local fooroot directory.

Flags:
      --auth-user string   Set authentication user when using SSH SFTP listener
      --listen string      Setup SSH SFTP listener on address:port instead of mounting
      --no-auth            Disable authentication when using SSH SFTP listener

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- pull.txt ---
Description:
  Pull files from instances

Usage:
  incus file pull [<remote>:]<instance>/<path> [[<remote>:]<instance>/<path>...] <target path> [flags]

Examples:
  incus file pull foo/etc/hosts .
     To pull /etc/hosts from the instance and write it to the current directory.

Flags:
  -p, --create-dirs   Create any directories necessary
  -r, --recursive     Recursively transfer files

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- push.txt ---
Description:
  Push files into instances

Usage:
  incus file push <source path>... [<remote>:]<instance>/<path> [flags]

Examples:
  incus file push /etc/hosts foo/etc/hosts
     To push /etc/hosts into the instance "foo".

Flags:
  -p, --create-dirs   Create any directories necessary
      --gid           Set the file's gid on push (default -1)
      --mode          Set the file's perms on push
  -r, --recursive     Recursively transfer files
      --uid           Set the file's uid on push (default -1)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- alias.txt ---
Description:
  Manage image aliases

Usage:
  incus image alias [flags]
  incus image alias [command]

Available Commands:
  create      Create aliases for existing images
  delete      Delete image aliases
  list        List image aliases
  rename      Rename aliases

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus image alias [command] --help" for more information about a command.

--- copy.txt ---
Description:
  Copy images between servers

  The auto-update flag instructs the server to keep this image up to date.
  It requires the source to be an alias and for it to be public.

Usage:
  incus image copy [<remote>:]<image> <remote>: [flags]

Aliases:
  copy, cp

Flags:
      --alias            New aliases to add to the image
      --auto-update      Keep the image up to date after initial copy
      --copy-aliases     Copy aliases from source
      --mode             Transfer mode. One of pull (default), push or relay (default "pull")
  -p, --profile          Profile to apply to the new image
      --public           Make image public
      --target-project   Copy to a project different from the source
      --vm               Copy virtual machine images

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete images

Usage:
  incus image delete [<remote>:]<image> [[<remote>:]<image>...] [flags]

Aliases:
  delete, rm

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- edit.txt ---
Description:
  Edit image properties

Usage:
  incus image edit [<remote>:]<image> [flags]

Examples:
  incus image edit <image>
      Launch a text editor to edit the properties

  incus image edit <image> < image.yaml
      Load the image properties from a YAML file

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- export.txt ---
Description:
  Export and download images

  The output target is optional and defaults to the working directory.

Usage:
  incus image export [<remote>:]<image> [<target>] [flags]

Flags:
      --vm   Query virtual machine images

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get-property.txt ---
Description:
  Get image properties

Usage:
  incus image get-property [<remote>:]<image> <key> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- import.txt ---
Description:
  Import image into the image store

  Directory import is only available on Linux and must be performed as root.

Usage:
  incus image import <tarball>|<directory>|<URL> [<rootfs tarball>] [<remote>:] [key=value...] [flags]

Flags:
      --alias    New aliases to add to the image
      --public   Make image public
      --reuse    If the image alias already exists, delete and create a new one

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- info.txt ---
Description:
  Show useful information about images

Usage:
  incus image info [<remote>:]<image> [flags]

Flags:
      --vm   Query virtual machine images

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List images

  Filters may be of the <key>=<value> form for property based filtering,
  or part of the image hash or part of the image alias name.

  The -c option takes a (optionally comma-separated) list of arguments
  that control which image attributes to output when displaying in table
  or csv format.

  Default column layout is: lfpdasu

  Column shorthand chars:

      l - Shortest image alias (and optionally number of other aliases)
      L - Newline-separated list of all image aliases
      f - Fingerprint (short)
      F - Fingerprint (long)
      p - Whether image is public
      d - Description
      e - Project
      a - Architecture
      s - Size
      u - Upload date
      t - Type

Usage:
  incus image list [<remote>:] [<filter>...] [flags]

Aliases:
  list, ls

Flags:
      --all-projects   Display images from all projects
  -c, --columns        Columns (default "lfpdatsu")
  -f, --format         Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- refresh.txt ---
Description:
  Refresh images

Usage:
  incus image refresh [<remote>:]<image> [[<remote>:]<image>...] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- set-property.txt ---
Description:
  Set image properties

Usage:
  incus image set-property [<remote>:]<image> <key> <value> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show image properties

Usage:
  incus image show [<remote>:]<image> [flags]

Flags:
      --vm   Query virtual machine images

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- unset-property.txt ---
Description:
  Unset image properties

Usage:
  incus image unset-property [<remote>:]<image> <key> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- acl.txt ---
Description:
  Manage network ACLs

Usage:
  incus network acl [flags]
  incus network acl [command]

Available Commands:
  create      Create new network ACLs
  delete      Delete network ACLs
  edit        Edit network ACL configurations as YAML
  get         Get values for network ACL configuration keys
  list        List available network ACLS
  rename      Rename network ACLs
  rule        Manage network ACL rules
  set         Set network ACL configuration keys
  show        Show network ACL configurations
  show-log    Show network ACL log
  unset       Unset network ACL configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- attach-profile.txt ---
Description:
  Attach network interfaces to profiles

Usage:
  incus network attach-profile [<remote>:]<network> <profile> [<device name>] [<interface name>] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- attach.txt ---
Description:
  Attach new network interfaces to instances

Usage:
  incus network attach [<remote>:]<network> <instance> [<device name>] [<interface name>] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- create.txt ---
Description:
  Create new networks

Usage:
  incus network create [<remote>:]<network> [key=value...] [flags]

Examples:
  incus network create foo
      Create a new network called foo

  incus network create foo < config.yaml
      Create a new network called foo using the content of config.yaml.

  incus network create bar network=baz --type ovn
      Create a new OVN network called bar using baz as its uplink network

Flags:
      --description   Network description
      --target        Cluster member name
  -t, --type          Network type

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete networks

Usage:
  incus network delete [<remote>:]<network> [flags]

Aliases:
  delete, rm

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- detach-profile.txt ---
Description:
  Detach network interfaces from profiles

Usage:
  incus network detach-profile [<remote>:]<network> <profile> [<device name>] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- detach.txt ---
Description:
  Detach network interfaces from instances

Usage:
  incus network detach [<remote>:]<network> <instance> [<device name>] [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- edit.txt ---
Description:
  Edit network configurations as YAML

Usage:
  incus network edit [<remote>:]<network> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- forward.txt ---
Description:
  Manage network forwards

Usage:
  incus network forward [flags]
  incus network forward [command]

Available Commands:
  create      Create new network forwards
  delete      Delete network forwards
  edit        Edit network forward configurations as YAML
  get         Get values for network forward configuration keys
  list        List available network forwards
  port        Manage network forward ports
  set         Set network forward keys
  show        Show network forward configurations
  unset       Unset network forward configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- get.txt ---
Description:
  Get values for network configuration keys

Usage:
  incus network get [<remote>:]<network> <key> [flags]

Flags:
  -p, --property   Get the key as a network property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- info.txt ---
Description:
  Get runtime information on networks

Usage:
  incus network info [<remote>:]<network> [flags]

Flags:
      --target   Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- integration.txt ---
Description:
  Manage network integrations

Usage:
  incus network integration [flags]
  incus network integration [command]

Available Commands:
  create      Create network integrations
  delete      Delete network integrations
  edit        Edit network integration configurations as YAML
  get         Get values for network integration configuration keys
  list        List network integrations
  rename      Rename network integrations
  set         Set network integration configuration keys
  show        Show network integration options
  unset       Unset network integration configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- list-allocations.txt ---
Description:
  List network allocations in use
  Default column layout: uatnm

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which instance attributes to output when displaying in table or csv
  format.

  Column arguments are either pre-defined shorthand chars (see below),
  or (extended) config keys.

  Commas between consecutive shorthand chars are optional.

  Pre-defined column shorthand chars:
    u - Used by
    a - Address
    t - Type
    n - NAT
    m - Mac Address

Usage:
  incus network list-allocations [flags]

Flags:
      --all-projects     Run against all projects
  -c, --columns          Columns (default "uatnm")
  -f, --format           Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")
  -p, --project string   Run again a specific project (default "default")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list-leases.txt ---
Description:
  List DHCP leases

  Default column layout: hmitL

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which network zone attributes to output when displaying in table or csv
  format.

  Column arguments are either pre-defined shorthand chars (see below),
  or (extended) config keys.

  Commas between consecutive shorthand chars are optional.

  Pre-defined column shorthand chars:
    h - Hostname
    m - MAC Address
    i - IP Address
    t - Type
    L - Location of the DHCP Lease (e.g. its cluster member)

Usage:
  incus network list-leases [<remote>:]<network> [flags]

Flags:
  -c, --columns   Columns (default "hmit")
  -f, --format    Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List available networks

  The -c option takes a (optionally comma-separated) list of arguments
  that control which image attributes to output when displaying in table
  or csv format.

  Default column layout is: ntm46dus
  Column shorthand chars:
  4 - IPv4 address
  6 - IPv6 address
  d - Description
  e - Project name
  m - Managed status
  n - Network Interface Name
  s - State
  t - Interface type
  u - Used by (count)

Usage:
  incus network list [<remote>:] [flags]

Aliases:
  list, ls

Flags:
      --all-projects   List networks in all projects
  -c, --columns        Columns (default "ntm46dus")
  -f, --format         Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- load-balancer.txt ---
Description:
  Manage network load balancers

Usage:
  incus network load-balancer [flags]
  incus network load-balancer [command]

Available Commands:
  backend     Manage network load balancer backends
  create      Create new network load balancers
  delete      Delete network load balancers
  edit        Edit network load balancer configurations as YAML
  get         Get values for network load balancer configuration keys
  info        Get current load balancer status
  list        List available network load balancers
  port        Manage network load balancer ports
  set         Set network load balancer keys
  show        Show network load balancer configurations
  unset       Unset network load balancer configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus network load-balancer [command] --help" for more information about a command.

--- peer.txt ---
Description:
  Manage network peerings

Usage:
  incus network peer [flags]
  incus network peer [command]

Available Commands:
  create      Create new network peering
  delete      Delete network peerings
  edit        Edit network peer configurations as YAML
  get         Get values for network peer configuration keys
  list        List available network peers
  set         Set network peer keys
  show        Show network peer configurations
  unset       Unset network peer configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- rename.txt ---
Description:
  Rename networks

Usage:
  incus network rename [<remote>:]<network> <new-name> [flags]

Aliases:
  rename, mv

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- set.txt ---
Description:
  Set network configuration keys

  For backward compatibility, a single configuration key may still be set with:
      incus network set [<remote>:]<network> <key> <value>

Usage:
  incus network set [<remote>:]<network> <key>=<value>... [flags]

Flags:
  -p, --property   Set the key as a network property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show network configurations

Usage:
  incus network show [<remote>:]<network> [flags]

Flags:
      --target   Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- unset.txt ---
Description:
  Unset network configuration keys

Usage:
  incus network unset [<remote>:]<network> <key> [flags]

Flags:
  -p, --property   Unset the key as a network property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- zone.txt ---
Description:
  Manage network zones

Usage:
  incus network zone [flags]
  incus network zone [command]

Available Commands:
  create      Create new network zones
  delete      Delete network zones
  edit        Edit network zone configurations as YAML
  get         Get values for network zone configuration keys
  list        List available network zoneS
  record      Manage network zone records
  set         Set network zone configuration keys
  show        Show network zone configurations
  unset       Unset network zone configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

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

--- add.txt ---
Description:
  Add profiles to instances

Usage:
  incus profile add [<remote>:]<instance> <profile> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- assign.txt ---
Description:
  Assign sets of profiles to instances

Usage:
  incus profile assign [<remote>:]<instance> <profiles> [flags]

Aliases:
  assign, apply

Examples:
  incus profile assign foo default,bar
      Set the profiles for "foo" to "default" and "bar".

  incus profile assign foo default
      Reset "foo" to only using the "default" profile.

  incus profile assign foo ''
      Remove all profile from "foo"

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- copy.txt ---
Description:
  Copy profiles

Usage:
  incus profile copy [<remote>:]<profile> [<remote>:]<profile> [flags]

Aliases:
  copy, cp

Flags:
      --refresh          Update the target profile from the source if it already exists
      --target-project   Copy to a project different from the source

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- create.txt ---
Description:
  Create profiles

Usage:
  incus profile create [<remote>:]<profile> [flags]

Examples:
  incus profile create p1
      Create a profile named p1

  incus profile create p1 < config.yaml
      Create a profile named p1 with configuration from config.yaml

Flags:
      --description   Profile description

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete profiles

Usage:
  incus profile delete [<remote>:]<profile> [flags]

Aliases:
  delete, rm

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- device.txt ---
Description:
  Manage devices

Usage:
  incus profile device [flags]
  incus profile device [command]

Available Commands:
  add         Add instance devices
  get         Get values for device configuration keys
  list        List instance devices
  remove      Remove instance devices
  set         Set device configuration keys
  show        Show full device configuration
  unset       Unset device configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus profile device [command] --help" for more information about a command.

--- edit.txt ---
Description:
  Edit profile configurations as YAML

Usage:
  incus profile edit [<remote>:]<profile> [flags]

Examples:
  incus profile edit <profile> < profile.yaml
      Update a profile using the content of profile.yaml

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get.txt ---
Description:
  Get values for profile configuration keys

Usage:
  incus profile get [<remote>:]<profile> <key> [flags]

Flags:
  -p, --property   Get the key as a profile property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List profiles

  The -c option takes a (optionally comma-separated) list of arguments
  that control which image attributes to output when displaying in table
  or csv format.

  Default column layout is: ndu

  Column shorthand chars:
  n - Profile Name
  d - Description
  u - Used By

Usage:
  incus profile list [<remote>:] [flags]

Aliases:
  list, ls

Flags:
      --all-projects   Display profiles from all projects
  -c, --columns        Columns (default "ndu")
  -f, --format         Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- remove.txt ---
Description:
  Remove profiles from instances

Usage:
  incus profile remove [<remote>:]<instance> <profile> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- rename.txt ---
Description:
  Rename profiles

Usage:
  incus profile rename [<remote>:]<profile> <new-name> [flags]

Aliases:
  rename, mv

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- set.txt ---
Description:
  Set profile configuration keys

  For backward compatibility, a single configuration key may still be set with:
      incus profile set [<remote>:]<profile> <key> <value>

Usage:
  incus profile set [<remote>:]<profile> <key><value>... [flags]

Flags:
  -p, --property   Set the key as a profile property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show profile configurations

Usage:
  incus profile show [<remote>:]<profile> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- unset.txt ---
Description:
  Unset profile configuration keys

Usage:
  incus profile unset [<remote>:]<profile> <key> [flags]

Flags:
  -p, --property   Unset the key as a profile property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- create.txt ---
Description:
  Create projects

Usage:
  incus project create [<remote>:]<project> [flags]

Examples:
  incus project create p1
      Create a project named p1

  incus project create p1 < config.yaml
      Create a project named p1 with configuration from config.yaml

Flags:
  -c, --config        Config key/value to apply to the new project
      --description   Project description

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete projects

Usage:
  incus project delete [<remote>:]<project> [flags]

Aliases:
  delete, rm

Flags:
  -f, --force   Force delete the project and everything it contains.

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- edit.txt ---
Description:
  Edit project configurations as YAML

Usage:
  incus project edit [<remote>:]<project> [flags]

Examples:
  incus project edit <project> < project.yaml
      Update a project using the content of project.yaml

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get-current.txt ---
Description:
  Show the current project

Usage:
  incus project get-current [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get.txt ---
Description:
  Get values for project configuration keys

Usage:
  incus project get [<remote>:]<project> <key> [flags]

Flags:
  -p, --property   Get the key as a project property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- info.txt ---
Description:
  Get a summary of resource allocations

Usage:
  incus project info [<remote>:]<project> [flags]

Flags:
  -f, --format        Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")
      --show-access   Show the instance's access list

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List projects

  The -c option takes a (optionally comma-separated) list of arguments
  that control which image attributes to output when displaying in table
  or csv format.
  Default column layout is: nipvbwzdu
  Column shorthand chars:

  n - Project Name
  i - Images
  p - Profiles
  v - Storage Volumes
  b - Storage Buckets
  w - Networks
  z - Network Zones
  d - Description
  u - Used By

Usage:
  incus project list [<remote>:] [flags]

Aliases:
  list, ls

Flags:
  -c, --columns   Columns (default "nipvbwzdu")
  -f, --format    Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- rename.txt ---
Description:
  Rename projects

Usage:
  incus project rename [<remote>:]<project> <new-name> [flags]

Aliases:
  rename, mv

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- set.txt ---
Description:
  Set project configuration keys

  For backward compatibility, a single configuration key may still be set with:
      incus project set [<remote>:]<project> <key> <value>

Usage:
  incus project set [<remote>:]<project> <key>=<value>... [flags]

Flags:
  -p, --property   Set the key as a project property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show project options

Usage:
  incus project show [<remote>:]<project> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- switch.txt ---
Description:
  Switch the current project

Usage:
  incus project switch [<remote>:]<project> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- unset.txt ---
Description:
  Unset project configuration keys

Usage:
  incus project unset [<remote>:]<project> <key> [flags]

Flags:
  -p, --property   Unset the key as a project property

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- add.txt ---
Description:
  Add new remote servers

  URL for remote resources must be HTTPS (https://).

  Basic authentication can be used when combined with the "simplestreams" protocol:
    incus remote add some-name https://LOGIN:PASSWORD@example.com/some/path --protocol=simplestreams

Usage:
  incus remote add [<remote>] <IP|FQDN|URL|token> [flags]

Flags:
      --accept-certificate   Accept certificate
      --auth-type            Server authentication type (tls or oidc)
      --project              Project to use for the remote
      --protocol             Server protocol (incus or simplestreams)
      --public               Public image server
      --token                Remote trust token

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- generate-certificate.txt ---
Description:
  Manually trigger the generation of a client certificate

Usage:
  incus remote generate-certificate [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get-default.txt ---
Description:
  Show the default remote

Usage:
  incus remote get-default [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List the available remotes

  Default column layout: nupaPsg

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which instance attributes to output when displaying in table or csv
  format.

  Column arguments are either pre-defined shorthand chars (see below),
  or (extended) config keys.

  Commas between consecutive shorthand chars are optional.

  Pre-defined column shorthand chars:
    n - Name
    u - URL
    p - Protocol
    a - Auth Type
    P - Public
    s - Static
    g - Global

Usage:
  incus remote list [flags]

Aliases:
  list, ls

Flags:
  -c, --columns   Columns (default "nupaPsg")
  -f, --format    Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- proxy.txt ---
Description:
  Run a local API proxy for the remote

Usage:
  incus remote proxy <remote>: <path> [flags]

Flags:
      --timeout   Proxy timeout (exits when no connections)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- remove.txt ---
Description:
  Remove remotes

Usage:
  incus remote remove <remote> [flags]

Aliases:
  remove, rm

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- rename.txt ---
Description:
  Rename remotes

Usage:
  incus remote rename <remote> <new-name> [flags]

Aliases:
  rename, mv

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- set-url.txt ---
Description:
  Set the URL for the remote

Usage:
  incus remote set-url <remote> <URL> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- switch.txt ---
Description:
  Switch the default remote

Usage:
  incus remote switch <remote> [flags]

Aliases:
  switch, set-default

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- create.txt ---
Description:
  Create instance snapshots

  When --stateful is used, attempt to checkpoint the instance's
  running state, including process memory state, TCP connections, ...

Usage:
  incus snapshot create [<remote>:]<instance> [<snapshot name>] [flags]

Examples:
  incus snapshot create u1 snap0
  	Create a snapshot of "u1" called "snap0".

  incus snapshot create u1 snap0 < config.yaml
  	Create a snapshot of "u1" called "snap0" with the configuration from "config.yaml".

Flags:
      --no-expiry   Ignore any configured auto-expiry for the instance
      --reuse       If the snapshot name already exists, delete and create a new one
      --stateful    Whether or not to snapshot the instance's running state

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete instance snapshots

Usage:
  incus snapshot delete [<remote>:]<instance> <snapshot name> [flags]

Aliases:
  delete, rm

Flags:
  -i, --interactive   Require user confirmation

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List instance snapshots

  Default column layout: nTEs

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which network zone attributes to output when displaying in table or csv
  format.

  Column arguments are either pre-defined shorthand chars (see below),
  or (extended) config keys.

  Commas between consecutive shorthand chars are optional.

  Pre-defined column shorthand chars:
    n - Name
    T - Taken At
    E - Expires At
    s - Stateful

Usage:
  incus snapshot list [<remote>:]<instance> [flags]

Flags:
  -c, --columns   Columns (default "nTEs")
  -f, --format    Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- rename.txt ---
Description:
  Rename instance snapshots

Usage:
  incus snapshot rename [<remote>:]<instance> <old snapshot name> <new snapshot name> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- restore.txt ---
Description:
  Restore instance from snapshots

  If --stateful is passed, then the running state will be restored too.

Usage:
  incus snapshot restore [<remote>:]<instance> <snapshot name> [flags]

Examples:
  incus snapshot restore u1 snap0
      Restore instance u1 to snapshot snap0

Flags:
      --stateful   Whether or not to restore the instance's running state from snapshot (if available)

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show instance snapshot configuration

Usage:
  incus snapshot show [<remote>:]<instance> <snapshot> [flags]

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- bucket.txt ---
Description:
  Manage storage buckets.

Usage:
  incus storage bucket [flags]
  incus storage bucket [command]

Available Commands:
  create      Create new custom storage buckets
  delete      Delete storage buckets
  edit        Edit storage bucket configurations as YAML
  export      Export storage bucket
  get         Get values for storage bucket configuration keys
  import      Import storage bucket
  key         Manage storage bucket keys
  list        List storage buckets
  set         Set storage bucket configuration keys
  show        Show storage bucket configurations
  unset       Unset storage bucket configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus storage bucket [command] --help" for more information about a command.

--- create.txt ---
Description:
  Create storage pools

Usage:
  incus storage create [<remote>:]<pool> <driver> [key=value...] [flags]

Examples:
  incus storage create s1 dir

  incus storage create s1 dir < config.yaml
      Create a storage pool using the content of config.yaml.
  	

Flags:
      --description   Storage pool description
      --target        Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- delete.txt ---
Description:
  Delete storage pools

Usage:
  incus storage delete [<remote>:]<pool> [flags]

Aliases:
  delete, rm

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- edit.txt ---
Description:
  Edit storage pool configurations as YAML

Usage:
  incus storage edit [<remote>:]<pool> [flags]

Examples:
  incus storage edit [<remote>:]<pool> < pool.yaml
      Update a storage pool using the content of pool.yaml.

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- get.txt ---
Description:
  Get values for storage pool configuration keys

Usage:
  incus storage get [<remote>:]<pool> <key> [flags]

Flags:
  -p, --property   Get the key as a storage property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- info.txt ---
Description:
  Show useful information about storage pools

Usage:
  incus storage info [<remote>:]<pool> [flags]

Flags:
      --bytes    Show the used and free space in bytes
      --target   Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- list.txt ---
Description:
  List available storage pools

  Default column layout: nDSdus

  == Columns ==
  The -c option takes a comma separated list of arguments that control
  which instance attributes to output when displaying in table or csv
  format.

  Column arguments are either pre-defined shorthand chars (see below),
  or (extended) config keys.

  Commas between consecutive shorthand chars are optional.

  Pre-defined column shorthand chars:
    n - Name
    D - Driver
    d - Description
    S - Source
    u - used by
    s - state

Usage:
  incus storage list [<remote>:] [flags]

Aliases:
  list, ls

Flags:
  -c, --columns   Columns (default "nDdus")
  -f, --format    Format (csv|json|table|yaml|compact), use suffix ",noheader" to disable headers and ",header" to enable it if missing, e.g. csv,header (default "table")

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- set.txt ---
Description:
  Set storage pool configuration keys

  For backward compatibility, a single configuration key may still be set with:
      incus storage set [<remote>:]<pool> <key> <value>

Usage:
  incus storage set [<remote>:]<pool> <key> <value> [flags]

Flags:
  -p, --property   Set the key as a storage property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- show.txt ---
Description:
  Show storage pool configurations and resources

Usage:
  incus storage show [<remote>:]<pool> [flags]

Flags:
      --resources   Show the resources available to the storage pool
      --target      Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- unset.txt ---
Description:
  Unset storage pool configuration keys

Usage:
  incus storage unset [<remote>:]<pool> <key> [flags]

Flags:
  -p, --property   Unset the key as a storage property
      --target     Cluster member name

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

--- volume.txt ---
Description:
  Manage storage volumes

  Unless specified through a prefix, all volume operations affect "custom" (user created) volumes.

Usage:
  incus storage volume [flags]
  incus storage volume [command]

Available Commands:
  attach         Attach new custom storage volumes to instances
  attach-profile Attach new custom storage volumes to profiles
  copy           Copy custom storage volumes
  create         Create new custom storage volumes
  delete         Delete custom storage volumes
  detach         Detach custom storage volumes from instances
  detach-profile Detach custom storage volumes from profiles
  edit           Edit storage volume configurations as YAML
  export         Export custom storage volume
  get            Get values for storage volume configuration keys
  import         Import custom storage volumes
  info           Show storage volume state information
  list           List storage volumes
  move           Move custom storage volumes between pools
  rename         Rename custom storage volumes
  set            Set storage volume configuration keys
  show           Show storage volume configurations
  snapshot       Manage storage volume snapshots
  unset          Unset storage volume configuration keys

Global Flags:
      --debug          Show all debug messages
      --force-local    Force using the local unix socket
  -h, --help           Print help
      --project        Override the source project
  -q, --quiet          Don't show progress information
      --sub-commands   Use with help or --help to view sub-commands
  -v, --verbose        Show all information messages
      --version        Print version number

Use "incus storage volume [command] --help" for more information about a command.