You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: FULL_HELP_DOCS.md
+74-4Lines changed: 74 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -369,6 +369,18 @@ To view the commands that will be executed, without executing them, use the --pr
369
369
370
370
**Usage:**`stellar contract build [OPTIONS]`
371
371
372
+
###### **Container Options:**
373
+
374
+
-`-d`, `--docker-host <DOCKER_HOST>` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock
375
+
-`--engine <ENGINE>` — Container engine to use [default: docker]
376
+
377
+
Possible values:
378
+
-`docker`: Docker, or any Docker-compatible CLI
379
+
-`apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon)
380
+
381
+
-`--cpus <CPUS>` — Limit the number of CPUs available to the container, e.g. `2`. A whole number: Apple's `container` engine does not accept fractional CPUs
382
+
-`--memory <MEMORY>` — Limit the memory available to the container, e.g. `2g` or `512m`
383
+
372
384
###### **Features:**
373
385
374
386
-`--features <FEATURES>` — Build with the list of features activated, space or comma separated
@@ -408,13 +420,12 @@ To view the commands that will be executed, without executing them, use the --pr
408
420
409
421
-`--print-commands-only` — Print commands to build without executing them
410
422
411
-
###### **Verifiable:**
423
+
###### **Verifiable Options:**
412
424
413
425
-`--verifiable` — Build inside a trusted Docker container and record SEP-58 metadata (`bldimg`, `source_uri`, `source_sha256`, `bldopt`) so the resulting WASM can be reproduced and verified by third parties. Implies `--locked`. Requires a clean git working tree
414
426
-`--image <IMAGE>` — Override the auto-selected container image used by `--verifiable`. Must be digest-pinned, e.g. `docker.io/stellar/stellar-cli@sha256:...`. Tag-only refs are rejected because SEP-58 requires content addressing
415
427
-`--source-sha256 <SOURCE_SHA256>` — SEP-58 source identification: SHA-256 of the source archive (recorded as the `source_sha256` meta entry). Optional with `--verifiable`: the archive is always generated and its SHA-256 computed for you. When supplied it's treated as a pin — the build fails if it doesn't match the generated archive
416
-
-`--source-uri <SOURCE_URI>` — SEP-58 source identification: URI where the source can be obtained, e.g. `https://example.com/src.tar.gz` (recorded as the `source_uri` meta entry). Optional with `--verifiable`; the recorded `source_sha256` is computed from the generated archive, unless `--source-sha256` is explicitly set
417
-
-`-d`, `--docker-host <DOCKER_HOST>` — Override the default docker host used by `--verifiable`
428
+
-`--source-uri <SOURCE_URI>` — entry). Optional with `--verifiable`; the recorded `source_sha256` is computed from the generated archive, unless `--source-sha256` is explicitly set
418
429
419
430
## `stellar contract extend`
420
431
@@ -1158,6 +1169,18 @@ Verify that a contract's WASM reproduces from the build metadata it records, per
1158
1169
1159
1170
**Usage:**`stellar contract verify [OPTIONS]`
1160
1171
1172
+
###### **Container Options:**
1173
+
1174
+
-`-d`, `--docker-host <DOCKER_HOST>` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock
1175
+
-`--engine <ENGINE>` — Container engine to use [default: docker]
1176
+
1177
+
Possible values:
1178
+
-`docker`: Docker, or any Docker-compatible CLI
1179
+
-`apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon)
1180
+
1181
+
-`--cpus <CPUS>` — Limit the number of CPUs available to the container, e.g. `2`. A whole number: Apple's `container` engine does not accept fractional CPUs
1182
+
-`--memory <MEMORY>` — Limit the memory available to the container, e.g. `2g` or `512m`
1183
+
1161
1184
###### **Global Options:**
1162
1185
1163
1186
-`--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
@@ -1169,7 +1192,6 @@ Verify that a contract's WASM reproduces from the build metadata it records, per
1169
1192
-`--wasm-hash <WASM_HASH>` — WASM hash (hex) to fetch the WASM from the network
1170
1193
-`--source-uri <SOURCE_URI>` — Local source code file or http(s) URL to use as the source when the WASM's recorded SEP-58 metadata has only `source_sha256` (no `source_uri`). Accepts http(s) URLs or local file paths
1171
1194
-`--trust` — Bypass interactive confirmation when the WASM's bldimg is not in the default trust list, or when the source is provided as an archive (source archives are never default-trusted)
1172
-
-`-d`, `--docker-host <DOCKER_HOST>` — Override the default docker host used by the rebuild
1173
1195
-`--keep` — Keep the materialized source and rebuild output instead of deleting them on exit, and print the path. Useful for debugging a byte mismatch (e.g. diffing the rebuilt WASM's metadata against the original)
1174
1196
1175
1197
###### **RPC Options:**
@@ -1712,6 +1734,8 @@ Start local networks in containers
1712
1734
-`logs` — Get logs from a running network container
1713
1735
-`start` — Start a container running a Stellar node, RPC, API, and friendbot (faucet)
1714
1736
-`stop` — Stop a network container started with `stellar container start`
1737
+
-`use` — Set the default container engine used by `stellar container` commands
1738
+
-`unset` — Unset the default container engine defined previously with `container use <engine>`
1715
1739
1716
1740
## `stellar container logs`
1717
1741
@@ -1728,6 +1752,11 @@ Get logs from a running network container
1728
1752
###### **Options:**
1729
1753
1730
1754
-`-d`, `--docker-host <DOCKER_HOST>` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock
1755
+
-`--engine <ENGINE>` — Container engine to use [default: docker]
1756
+
1757
+
Possible values:
1758
+
-`docker`: Docker, or any Docker-compatible CLI
1759
+
-`apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon)
1731
1760
1732
1761
## `stellar container start`
1733
1762
@@ -1750,6 +1779,14 @@ By default, when starting a testnet container, without any optional arguments, i
1750
1779
###### **Options:**
1751
1780
1752
1781
-`-d`, `--docker-host <DOCKER_HOST>` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock
1782
+
-`--engine <ENGINE>` — Container engine to use [default: docker]
1783
+
1784
+
Possible values:
1785
+
-`docker`: Docker, or any Docker-compatible CLI
1786
+
-`apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon)
1787
+
1788
+
-`--cpus <CPUS>` — Limit the number of CPUs available to the container, e.g. `2`. A whole number: Apple's `container` engine does not accept fractional CPUs
1789
+
-`--memory <MEMORY>` — Limit the memory available to the container, e.g. `2g` or `512m`
1753
1790
-`--name <NAME>` — Optional argument to specify the container name
1754
1791
-`-l`, `--limits <LIMITS>` — Optional argument to specify the limits for the local network only
1755
1792
-`-p`, `--ports-mapping <PORTS_MAPPING>` — Argument to specify the `HOST_PORT:CONTAINER_PORT` mapping
@@ -1774,6 +1811,39 @@ Stop a network container started with `stellar container start`
1774
1811
###### **Options:**
1775
1812
1776
1813
-`-d`, `--docker-host <DOCKER_HOST>` — Optional argument to override the default docker host. This is useful when you are using a non-standard docker host path for your Docker-compatible container runtime, e.g. Docker Desktop defaults to $HOME/.docker/run/docker.sock instead of /var/run/docker.sock
1814
+
-`--engine <ENGINE>` — Container engine to use [default: docker]
1815
+
1816
+
Possible values:
1817
+
-`docker`: Docker, or any Docker-compatible CLI
1818
+
-`apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon)
1819
+
1820
+
## `stellar container use`
1821
+
1822
+
Set the default container engine used by `stellar container` commands
1823
+
1824
+
**Usage:**`stellar container use [OPTIONS] <ENGINE>`
1825
+
1826
+
###### **Arguments:**
1827
+
1828
+
-`<ENGINE>` — Container engine to use by default
1829
+
1830
+
Possible values:
1831
+
-`docker`: Docker, or any Docker-compatible CLI
1832
+
-`apple-container`: Apple's `container` CLI (macOS 26+, Apple silicon)
1833
+
1834
+
###### **Global Options:**
1835
+
1836
+
-`--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
1837
+
1838
+
## `stellar container unset`
1839
+
1840
+
Unset the default container engine defined previously with `container use <engine>`
1841
+
1842
+
**Usage:**`stellar container unset [OPTIONS]`
1843
+
1844
+
###### **Global Options:**
1845
+
1846
+
-`--config-dir <CONFIG_DIR>` — Location of config directory. By default, it uses `$XDG_CONFIG_HOME/stellar` if set, falling back to `~/.config/stellar` otherwise. Contains configuration files, aliases, and other persistent settings
0 commit comments