Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion src/docs/avocado-linux/tools/avocado-cli/commands/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Build all components (SDK compile, extensions, and runtime images)
Usage: avocado build [OPTIONS]

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-r, --runtime <RUNTIME> Runtime name to build (if not provided, builds all runtimes)
-e, --extension <EXTENSION> Extension name to build (if not provided, builds all required extensions)
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
16 changes: 16 additions & 0 deletions src/docs/avocado-linux/tools/avocado-cli/commands/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,22 @@ Options:
Container tool to use (docker/podman) [default: docker]
-v, --verbose
Enable verbose output
--stamps
Also remove stamp files (requires -C/--config and --target)
-C, --config <CONFIG>
Path to avocado.yaml configuration file (required when --stamps or --unlock is used)
--target <TARGET>
Target architecture (required when --stamps or --unlock is used)
-f, --force
Force removal by killing and removing containers using the volume
--unlock
Also unlock (clear lock file entries) for all sysroots (requires -C/--config)
--runs-on <USER@HOST>
Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT>
NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH>
SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help
Print help

Expand Down
5 changes: 4 additions & 1 deletion src/docs/avocado-linux/tools/avocado-cli/commands/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Deploy a runtime to a device (shortcut for 'runtime deploy')
Usage: avocado deploy [OPTIONS] --runtime <RUNTIME> --device <DEVICE>

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-r, --runtime <RUNTIME> Runtime name to deploy
-t, --target <TARGET> Target architecture
-d, --device <DEVICE> Device IP address or hostname to deploy to
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Build sysext and/or confext extensions from configuration
Usage: avocado ext build [OPTIONS] --extension <EXTENSION>

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-e, --extension <EXTENSION> Name of the extension to build (must be defined in config)
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Usage: avocado ext checkout [OPTIONS] --extension <EXTENSION> --ext-path <EXT_PA

Options:
-C, --config <CONFIG>
Path to avocado.toml configuration file [default: avocado.toml]
Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose
Enable verbose output
-e, --extension <EXTENSION>
Expand All @@ -18,6 +18,12 @@ Options:
Destination path in source directory (relative to src root)
--container-tool <CONTAINER_TOOL>
Container tool to use (docker/podman) [default: docker]
--runs-on <USER@HOST>
Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT>
NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH>
SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help
Print help

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Clean an extension's sysroot
Usage: avocado ext clean [OPTIONS] --extension <EXTENSION>

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-e, --extension <EXTENSION> Name of the extension to clean
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,12 @@ List dependencies for extensions
Usage: avocado ext deps [OPTIONS]

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-e, --extension <EXTENSION> Name of the extension to show dependencies for (if not provided, shows all extensions)
-t, --target <TARGET> Target architecture
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
5 changes: 4 additions & 1 deletion src/docs/avocado-linux/tools/avocado-cli/commands/ext/dnf.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,15 @@ Arguments:
[COMMAND]... DNF command and arguments to execute

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-e, --extension <EXTENSION> Name of the extension to operate on
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
18 changes: 18 additions & 0 deletions src/docs/avocado-linux/tools/avocado-cli/commands/ext/fetch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
```
Fetch remote extensions from repo, git, or path sources

Usage: avocado ext fetch [OPTIONS]

Options:
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-f, --force Force re-fetch even if already installed
-e, --extension <EXTENSION> Name of the extension to fetch (if not provided, fetches all remote extensions)
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,15 @@ Create squashfs image from system extension
Usage: avocado ext image [OPTIONS] --extension <EXTENSION>

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-e, --extension <EXTENSION> Name of the extension to create image for
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Install dependencies into extension sysroots
Usage: avocado ext install [OPTIONS]

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-f, --force Force the operation to proceed, bypassing warnings or confirmation prompts
-e, --extension <EXTENSION> Name of the extension to install (if not provided, installs all extensions)
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
9 changes: 6 additions & 3 deletions src/docs/avocado-linux/tools/avocado-cli/commands/ext/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ List extension names
Usage: avocado ext list [OPTIONS]

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-t, --target <TARGET> Target architecture
-h, --help Print help
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-t, --target <TARGET> Target architecture
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Package extension sysroot into an RPM
Usage: avocado ext package [OPTIONS] --extension <EXTENSION>

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-e, --extension <EXTENSION> Name of the extension to package
-t, --target <TARGET> Target architecture
--out-dir <OUTPUT_DIR> Output directory on host for the RPM package (relative or absolute path). If not specified, RPM stays in container at $AVOCADO_PREFIX/output/extensions
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
5 changes: 4 additions & 1 deletion src/docs/avocado-linux/tools/avocado-cli/commands/fetch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Fetch and refresh repository metadata for sysroots
Usage: avocado fetch [OPTIONS]

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-e, --extension <EXTENSION> Extension name to fetch metadata for (if not provided, fetches for all sysroots)
-r, --runtime <RUNTIME> Runtime name to fetch metadata for (if not provided, fetches for all sysroots)
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,17 @@ Start a HITL server container with preconfigured settings
Usage: avocado hitl server [OPTIONS]

Options:
-C, --config-path <CONFIG_PATH> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config-path <CONFIG_PATH> Path to avocado.yaml configuration file [default: avocado.yaml]
-e, --extension <EXTENSIONS> Extensions to create NFS exports for
--container-arg <CONTAINER_ARGS> Additional container arguments
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
-t, --target <TARGET> Target to build for
-v, --verbose Enable verbose output
-p, --port <PORT> NFS port number to use
--no-stamps Disable stamp validation
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
20 changes: 18 additions & 2 deletions src/docs/avocado-linux/tools/avocado-cli/commands/init.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,23 @@ Arguments:
[DIRECTORY] Directory to initialize (defaults to current directory)

Options:
--target <TARGET> Target architecture (e.g., "qemux86-64")
-h, --help Print help
--target <TARGET>
Target architecture (e.g., "qemux86-64")
--reference <REFERENCE>
Reference example to initialize from (downloads from avocado-os/references)
--reference-branch <REFERENCE_BRANCH>
Branch to fetch reference from (defaults to "main")
--reference-commit <REFERENCE_COMMIT>
Specific commit SHA to fetch reference from
--reference-repo <REFERENCE_REPO>
Repository to fetch reference from (format: "owner/repo", defaults to "avocado-linux/avocado-os")
--runs-on <USER@HOST>
Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT>
NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH>
SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help
Print help

```
5 changes: 4 additions & 1 deletion src/docs/avocado-linux/tools/avocado-cli/commands/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,16 @@ Install all components (SDK, extensions, and runtime dependencies)
Usage: avocado install [OPTIONS]

Options:
-C, --config <CONFIG> Path to avocado.toml configuration file [default: avocado.toml]
-C, --config <CONFIG> Path to avocado.yaml configuration file [default: avocado.yaml]
-v, --verbose Enable verbose output
-f, --force Force the operation to proceed, bypassing warnings or confirmation prompts
-r, --runtime <RUNTIME> Runtime name to install dependencies for (if not provided, installs for all runtimes)
-t, --target <TARGET> Target architecture
--container-arg <CONTAINER_ARGS> Additional arguments to pass to the container runtime
--dnf-arg <DNF_ARGS> Additional arguments to pass to DNF commands
--runs-on <USER@HOST> Run command on remote host using local volume via NFS (format: user@host)
--nfs-port <NFS_PORT> NFS port for remote execution (auto-selects from 12050-12099 if not specified)
--sdk-arch <ARCH> SDK container architecture for cross-arch emulation via Docker buildx/QEMU (aarch64 or x86-64)
-h, --help Print help

```
Loading