Skip to content
Merged
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
7 changes: 5 additions & 2 deletions skills/podcvd/SKILL.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,15 @@ This skill fully orchestrates the lifecycle of Cuttlefish instances and their gr

## Prerequisites

* **Package Requirement**: `podcvd` is delivered via the `cuttlefish-podcvd` Debian package.
* **Initial Setup**: To use `podcvd` successfully, the `podcvd-setup` binary (installed with the package) **MUST** be executed at least once after installation to perform the necessary initialization.
* **Required Build Artifacts**: Launching Cuttlefish instances requires appropriate Cuttlefish host tools (host binaries and libraries) and Android device images (such as system.img, boot.img, and vendor.img):
* **Inside an Android Workspace**: You must initialize the environment (e.g., `lunch <target>`) and build the required targets (e.g., `m`) to ensure that valid Cuttlefish host tools (inside `ANDROID_HOST_OUT`) and Android device images (inside `ANDROID_PRODUCT_OUT`) are generated.
* **Outside an Android Workspace**: If you are not in an active build environment, you must ensure that compatible, pre-built Cuttlefish host tools and Android device images are already present in the working directory or are otherwise accessible via the relevant environment paths (like `ANDROID_HOST_OUT` and `ANDROID_PRODUCT_OUT`).

## Setup & Installation Guidance

* **Missing `podcvd` Command**: If `podcvd` is not installed (e.g., `which podcvd` fails), install the package using `sudo apt install cuttlefish-podcvd -y`.
* **Host Initialization Required**: If executing `podcvd` fails due to an unconfigured host (e.g., explicit prompts to run `podcvd-setup` or missing device permissions such as `/dev/kvm`), execute `podcvd-setup` to initialize the host.

## Mandatory Environment Configuration (Client ID Tracking)

Setting the `PODCVD_CLIENT_ID` environment variable is **MANDATORY** whenever executing `podcvd` subcommands. This ensures proper session tracking and prevents resource collisions.
Expand Down
Loading