Skip to main content

AUTH_EDIT

Constant AUTH_EDIT 

Source
pub const AUTH_EDIT: &str = "\
Change an existing profile: its name, its note, the organisation it points at.

```
ytcli auth edit work --description \"production — customer data\"
ytcli auth edit work --name prod
ytcli auth edit sandbox --org-id 67890 --queue TEST
ytcli auth edit sandbox --clear-description
```

A local edit to the config file: no token is read and no request is made, so a
profile can be corrected whether or not its credentials currently work. What you
do not pass is not touched.

`--description` is the note saying which organisation this is. It is shown by
`auth list`, by `auth status`, and on the one-line `→ profile=… org=…` that
every command prints on stderr — which is where it earns its keep: an
organisation id is a number nobody recognises, and `work2` does not say whose
data it is. `auth login --description TEXT` sets the same field while creating a
profile, and a later login leaves an existing one alone.

`--name` moves the whole profile, display settings included, and carries
`default_profile` with it. A committed `.tracker.toml` naming the old name is
reported rather than rewritten: it is shared with other people.

Changing `--org-id`, `--org-kind` or `--account` is not verified here — nothing
is sent. `ytcli auth status --active-only` checks it afterwards.";