WendyOS Docs
Wendy CLIproject

wendy project add

Add a capability or integration

Syntax

wendy project add [name] [flags]

Examples

  wendy project add
  wendy project add http --port 8080
  wendy project add persist --name recordings --path /data
  wendy project add camera --service vision

Arguments

Argument notation from the CLI: [name]. Angle brackets mark required values; square brackets mark optional values. See Details for command-specific validation.

Flags

Flags below include inherited options. Types and defaults come from the CLI source. An empty default means no value is configured.

FlagTypeDefaultDescription
--allowliststring(empty)Allowed cameras. Comma-separated camera names or paths; empty for all
--busstring(empty)I2C bus. Bare device name, for example i2c-1
--devicestring(empty)Target device host (hostname, IP, or host:port); 'wendy run' accepts a comma-separated list to deploy one build to several devices (needs a remote build host and --detach). Defaults to $WENDY_DEVICE, then the saved default device
--distrostring(empty)ROS distribution. For example humble or jazzy
--domain-idstring(empty)Domain ID. 0 to 232; empty derives a stable ID from appId
--dry-runboolfalseValidate and preview the changes without saving
--filestringwendy.jsonManifest file or project directory
--jsonboolfalseOutput in JSON format
--modestring(empty)Network mode. bridge: outbound internet; host: host network; mesh: mesh peers; none: no network; host-admin: host network administration
--namestring(empty)Storage namespace. Apps with this namespace share data
--pathstring(empty)Mount path. Absolute path inside the container
--pinsstring(empty)GPIO pins. Comma-separated pins, or empty for all GPIO chips
--portstring(empty)Port. A port between 1 and 65535
--portsstring(empty)Mesh port mappings. JSON array, for example [{"host":8080,"container":8080}]; empty for none
--rmwstring(empty)Middleware. cyclonedds, fastrtps, connextdds, or gurumdds
--scopestring(empty)Scope. Who sees the app's topics: app (only this app), device (every app on the device), peripherals (the device and attached hardware), or network
--serial-devicestring(empty)Serial device. Bare USB tty name, for example ttyACM0 or ttyUSB0
--servicestring(empty)Edit settings for this service instead of app defaults
--service-cidrstring(empty)Mesh service CIDR. Required only for mesh mode, for example 10.42.0.0/16
--streamsstring(empty)Recording streams. JSON object of recording streams; use edit --raw for larger configurations

Output

Output depends on the operation and selected target. Use the command help for additional guidance..

JSON output

The global --json option requests machine-readable output. The CLI also selects JSON mode when no interactive terminal is attached. Support and payloads are command-specific; this flag does not guarantee a single JSON document for commands that stream logs or invoke build tools. Consult Details before parsing command output.

Exit codes

The CLI entry point returns 0 on success and for its user-cancelled or default-cleared results. Other returned errors exit with 1 and print a diagnostic to stderr. Some operations may terminate through subprocess or signal handling; do not infer application health from the CLI exit code alone.

Common errors

Check argument values and flag combinations against the synopsis above. For discovery, build, port, and readiness failures, see deployment troubleshooting. Command-specific constraints are in Details.

See also

Details

Add a capability or integration. Omit the name to open a searchable picker. Use wendy project add <name> --help for that item's fields.

Names: network Network access bluetooth Bluetooth access avahi Private mDNS (Avahi) nan Wi-Fi Aware control video Video access (deprecated; use camera) gpu GPU access npu NPU access persist Persistent storage audio Microphone and speakers camera Camera access usb USB access i2c I2C bus gpio GPIO pins spi SPI bus input Input devices serial USB serial device mcp MCP server display Display access episode-write Episode recording notifications Notifications admin Agent administration build Container builds http Web interface ros2 ROS 2

Use the command help for additional guidance.

On this page