Merge pull request #175 from canonical/update-cmd-ref

Update command reference documentation

reference/cmd-ref/amc/ams.amc.md

@@ -0,0 +1,45 @@
+## ams.amc
+
+Anbox Management Client
+
+### Synopsis
+
+Anbox Management Client.
+
+The Anbox Management Client (AMC) manages containers in Anbox Cloud.
+You can use it to create, launch and manage applications on any machine.
+
+See https://anbox-cloud.io/docs for detailed information on how to work
+with Anbox Cloud.
+
+### Options
+
+```
+  -h, --help   help for ams.amc
+```
+
+### SEE ALSO
+
+* [ams.amc addon](ams.amc_addon.md)	 - Manage addons
+* [ams.amc application](ams.amc_application.md)	 - Manage applications
+* [ams.amc benchmark](ams.amc_benchmark.md)	 - Benchmark your Anbox Cloud deployment
+* [ams.amc completion](ams.amc_completion.md)	 - Generate the autocompletion script for the specified shell
+* [ams.amc config](ams.amc_config.md)	 - Manage AMS configuration
+* [ams.amc delete](ams.amc_delete.md)	 - Delete an instance
+* [ams.amc exec](ams.amc_exec.md)	 - Execute a command inside an instance
+* [ams.amc image](ams.amc_image.md)	 - Manage images
+* [ams.amc info](ams.amc_info.md)	 - Provide general information about the connected AMS service
+* [ams.amc init](ams.amc_init.md)	 - Create an instance but do not start it immediately
+* [ams.amc launch](ams.amc_launch.md)	 - Launch an instance
+* [ams.amc list](ams.amc_list.md)	 - List instances
+* [ams.amc logs](ams.amc_logs.md)	 - Show runtime logs of an instance
+* [ams.amc node](ams.amc_node.md)	 - Manage nodes
+* [ams.amc remote](ams.amc_remote.md)	 - Interact with remote AMS daemons
+* [ams.amc shell](ams.amc_shell.md)	 - Open a shell inside a running instance
+* [ams.amc show](ams.amc_show.md)	 - Show information about an instance
+* [ams.amc show-log](ams.amc_show-log.md)	 - Show an instance log file
+* [ams.amc start](ams.amc_start.md)	 - Start an existing instance
+* [ams.amc stop](ams.amc_stop.md)	 - Stop a running instance
+* [ams.amc wait](ams.amc_wait.md)	 - Wait for an instance to reach a specific condition
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_addon.md

@@ -0,0 +1,32 @@
+## ams.amc addon
+
+Manage addons
+
+### Synopsis
+
+Manage addons.
+
+Addons are a way of customising the images that are used as the base for containers.
+
+Basically, an addon is a tarball that provides several hooks and additional metadata.
+An example for an addon is one that enables the SSH service inside a container, to
+provide access from the outside for any kind of automation of the container.
+
+See https://anbox-cloud.io/docs/ref/addons for detailed information.
+
+### Options
+
+```
+  -h, --help   help for addon
+```
+
+### SEE ALSO
+
+* [ams.amc](ams.amc.md)	 - Anbox Management Client
+* [ams.amc addon add](ams.amc_addon_add.md)	 - Add an addon
+* [ams.amc addon delete](ams.amc_addon_delete.md)	 - Delete an existing addon
+* [ams.amc addon list](ams.amc_addon_list.md)	 - List available addons
+* [ams.amc addon show](ams.amc_addon_show.md)	 - Show more information about a specific addon
+* [ams.amc addon update](ams.amc_addon_update.md)	 - Update an existing addon
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_addon_add.md

@@ -0,0 +1,45 @@
+## ams.amc addon add
+
+Add an addon
+
+### Synopsis
+
+Add an addon.
+
+Addons can be created from plain directories or tarballs or zip archives.
+A valid addon must contain a manifest and hooks.
+
+Addons are not used automatically, but they must be enabled for an application
+by adding them to the application manifest.
+Alternatively, you can enable them globally by setting the configuration item
+'application.addons'.
+
+```
+ams.amc addon add <name> (<directory> | <.tar.bz2 tarball> | <.zip zip archive>) [flags]
+```
+
+### Examples
+
+```
+$ tree my-addon
+my-addon/
+├── hooks
+│   └── install
+└── manifest.yaml
+
+$ amc addon add foo my-addon/
+
+```
+
+### Options
+
+```
+  -h, --help             help for add
+  -t, --timeout string   Maximum time to wait for the operation to complete (default "5m")
+```
+
+### SEE ALSO
+
+* [ams.amc addon](ams.amc_addon.md)	 - Manage addons
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_addon_delete.md

@@ -0,0 +1,39 @@
+## ams.amc addon delete
+
+Delete an existing addon
+
+### Synopsis
+
+Delete an existing addon.
+
+Non-interactive deletion can be achieved with the '--yes'/'-y' flag.
+
+
+```
+ams.amc addon delete <name> [flags]
+```
+
+### Examples
+
+```
+$ amc addon delete foo
+The following addon will be REMOVED:
+  - foo
+Do you want to continue? [Y/n]: Y
+
+```
+
+### Options
+
+```
+  -h, --help             help for delete
+  -t, --timeout string   Maximum time to wait for the operation to complete (default "5m")
+  -v, --version int      Version of the application to delete. If not specified, all versions are deleted.
+  -y, --yes              Assume 'yes' as answer to all prompts and run non-interactively
+```
+
+### SEE ALSO
+
+* [ams.amc addon](ams.amc_addon.md)	 - Manage addons
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_addon_list.md

@@ -0,0 +1,40 @@
+## ams.amc addon list
+
+List available addons
+
+### Synopsis
+
+List available addons.
+
+Formatting can be controlled with the '--format' flag.
+Valid formats are 'table' (see example), 'json' and 'csv'.
+
+
+```
+ams.amc addon list [flags]
+```
+
+### Examples
+
+```
+$ amc addon list
++------+----------+---------+
+| NAME | VERSIONS | USED BY |
++------+----------+---------+
+| foo  | 1        |         |
++------+----------+---------+
+
+```
+
+### Options
+
+```
+      --format string   Output format - 'table', 'json' or 'csv' (default "table")
+  -h, --help            help for list
+```
+
+### SEE ALSO
+
+* [ams.amc addon](ams.amc_addon.md)	 - Manage addons
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_addon_show.md

@@ -0,0 +1,40 @@
+## ams.amc addon show
+
+Show more information about a specific addon
+
+### Synopsis
+
+Show more information about a specific addon.
+
+Formatting can be controlled with the '--format' flag.
+Valid formats are 'json' and 'yaml'.
+
+```
+ams.amc addon show <name> [flags]
+```
+
+### Examples
+
+```
+$ amc addon show foo
+name: foo
+versions:
+  0:
+    size: 273B
+    created-at: 2019-07-15 14:02:30 +0000 UTC
+used_by: []
+
+```
+
+### Options
+
+```
+      --format string   Output format - 'json' or 'yaml' (default "yaml")
+  -h, --help            help for show
+```
+
+### SEE ALSO
+
+* [ams.amc addon](ams.amc_addon.md)	 - Manage addons
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_addon_update.md

@@ -0,0 +1,33 @@
+## ams.amc addon update
+
+Update an existing addon
+
+```
+ams.amc addon update <name> <addon_path> [flags]
+```
+
+### Examples
+
+```
+$ tree addon
+addon/
+├── hooks
+│   └── install
+└── manifest.yaml
+
+$ amc addon update foo addon/
+
+```
+
+### Options
+
+```
+  -h, --help             help for update
+  -t, --timeout string   Maximum time to wait for the operation to complete (default "5m")
+```
+
+### SEE ALSO
+
+* [ams.amc addon](ams.amc_addon.md)	 - Manage addons
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_application.md

@@ -0,0 +1,49 @@
+## ams.amc application
+
+Manage applications
+
+### Synopsis
+
+Manage applications.
+
+Applications are the centrepiece of Anbox Cloud.
+
+An application usually encapsulates one Android application and manages it
+within the cluster.
+The application installs the supplied APK to make it available to users.
+Applications can be updated, pushed to a central registry and more.
+See https://anbox-cloud.io/docs/exp/applications for detailed information.
+
+Android applications must go through a bootstrap process before they can
+run on Anbox Cloud. This bootstrap process helps to improve the performance
+and decrease the boot times.
+
+Applications are versioned. Every time you update an application, its version
+number is incremented. Application versions are not automatically published.
+While you can launch an unpublished application, it is recommended to do so
+only for testing purposes.
+
+Once ready for use, you can publish a specific version. It will then be used
+for any container launched for the application.
+
+
+### Options
+
+```
+  -h, --help   help for application
+```
+
+### SEE ALSO
+
+* [ams.amc](ams.amc.md)	 - Anbox Management Client
+* [ams.amc application create](ams.amc_application_create.md)	 - Create an application
+* [ams.amc application delete](ams.amc_application_delete.md)	 - Delete an application
+* [ams.amc application list](ams.amc_application_list.md)	 - List created applications
+* [ams.amc application publish](ams.amc_application_publish.md)	 - Mark an application version as published
+* [ams.amc application revoke](ams.amc_application_revoke.md)	 - Revoke a published application version
+* [ams.amc application set](ams.amc_application_set.md)	 - Update fields for an application
+* [ams.amc application show](ams.amc_application_show.md)	 - Show information about a specific application
+* [ams.amc application unset](ams.amc_application_unset.md)	 - Reset an application field
+* [ams.amc application update](ams.amc_application_update.md)	 - Update an existing application
+
+###### Auto generated by spf13/cobra on 8-Oct-2024

reference/cmd-ref/amc/ams.amc_application_create.md

@@ -0,0 +1,42 @@
+## ams.amc application create
+
+Create an application
+
+### Synopsis
+
+Create an application.
+
+Applications can be created from plain directories, tarballs or zip archives.
+A valid application must contain an APK and a manifest that defines various
+application properties.
+
+
+```
+ams.amc application create (<directory> | <.tar.bz2 tarball> | <.zip archive>) [flags]
+```
+
+### Examples
+
+```
+$ tree my-app
+my-app/
+├── app.apk
+└── manifest.yaml
+
+$ amc application create my-app
+
+```
+
+### Options
+
+```
+  -h, --help             help for create
+  -t, --timeout string   Maximum time to wait for the operation to complete (default "5m")
+      --vm               Create an application using VMs instead of containers
+```
+
+### SEE ALSO
+
+* [ams.amc application](ams.amc_application.md)	 - Manage applications
+
+###### Auto generated by spf13/cobra on 8-Oct-2024