Skip to content

Commit 591ca3c

Browse files
docs(cli): name the namespace the --as flag consumes
`--as` is an ordinary address reference while `$ST_AGENT` carries the exact agent ID, and this stack is what makes the two strings diverge - so a script passing `--as "$ST_AGENT"` breaks the moment its subject declares an address. The flag help now says which namespace it reads instead of reading as "the same value, with a default".
1 parent f74c9e4 commit 591ca3c

1 file changed

Lines changed: 3 additions & 2 deletions

File tree

src/main.rs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -661,8 +661,9 @@ struct MsgCtx {
661661
/// default st2 catalog.
662662
#[arg(long, conflicts_with = "catalog_path")]
663663
root: Option<PathBuf>,
664-
/// The acting identity — who the message is `from` / whose inbox is "mine". Defaults to
665-
/// `$ST_AGENT`.
664+
/// The acting identity — who the message is `from` / whose inbox is "mine". An ordinary
665+
/// address reference, unlike `$ST_AGENT`, which carries the exact agent ID; the two are
666+
/// different strings once a subject declares an explicit `address`. Defaults to `$ST_AGENT`.
666667
#[arg(long = "as")]
667668
as_id: Option<String>,
668669
/// Host used to resolve `<host>.<identity>` bus ids. Defaults to the local hostname.

0 commit comments

Comments
 (0)