Skip to content

docs(minimal): hide --network and --ingress from the CLI surface #999

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
norrietaylor merged 1 commit into from
Jul 28, 2026
Merged

docs(minimal): hide --network and --ingress from the CLI surface #999

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 13 additions & 0 deletions crates/minimal/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -299,11 +299,24 @@ pub struct ActivateArgs {
#[arg(long, value_enum, default_value_t = SyncMode::Tarball)]
pub sync: SyncMode,
/// Network mode: no-net, host-net (default), or own-ip.
///
/// Hidden from `--help` while `own-ip` is not usable on an installed host:
/// the daemon resolves a switch binary that no install ships yet
/// (gominimal/minimal#980), so advertising the flag offers a mode that
/// cannot work outside a dev checkout. Still accepted, and `host-net`
/// remains the default, so nothing that passes it today breaks. Unhide,
/// and restore the row in docs/reference/cli-min.md, once own-ip works
/// from an install.
#[arg(long, value_enum, default_value_t = CliNetworkMode::HostNet)]
#[clap(hide = true)]
pub network: CliNetworkMode,
/// Static ingress port mapping `EXT:INT[/PROTO]` (PROTO = tcp|udp, default
/// tcp). Repeatable. Requires `--network own-ip`.
///
/// Hidden for the same reason as `--network`: it is only meaningful with
/// `--network own-ip`.
#[arg(long = "ingress", value_name = "EXT:INT[/PROTO]")]
#[clap(hide = true)]
pub ingress: Vec<String>,
/// Apply the named loadout from `<config>/minimal/loadouts/<NAME>.toml`.
/// Repeatable. If any `--loadout` is specified, defaults from
Expand Down
2 changes: 0 additions & 2 deletions docs/reference/cli-min.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,6 @@ the current directory).
|------|-------|-------------|
| `--name <NAME>` | `-n` | Optional session name |
| `--sync <MODE>` | | How to load project files into the session: `tarball` (default: stream a tarball of your project and unpack it) or `none` (do not populate the worktree) |
| `--network <MODE>` | | Network mode: `no-net`, `host-net` (default), or `own-ip` |
| `--ingress <EXT:INT[/PROTO]>` | | Static ingress port mapping (`PROTO` = `tcp`\|`udp`, default `tcp`). Repeatable. Requires `--network own-ip` |
| `--loadout <NAME>` | | Apply the named loadout from `<config>/minimal/loadouts/<NAME>.toml`. Repeatable; if given, config-file `default_loadouts` are ignored |
| `--no-loadouts` | | Apply no loadouts at all (also skips the config's `default_loadouts`). Conflicts with `--loadout` |
| `--no-prompt` | | Fail instead of prompting when the daemon surfaces items user policy can't auto-decide; implied when stdin/stderr isn't a TTY |
Expand Down