Skip to main content

Module cli

Module cli 

Source

Re-exports§

pub use super::contains_control_chars as control_chars;
pub use super::snippet_added;
pub use super::snippet_removed;
pub use super::snippet_updated;
pub use super::ALIAS_PREFIX_INVALID;
pub use super::PROVIDER_TOKEN_REQUIRED_GCP;
pub use super::PROVIDER_TOKEN_REQUIRED_ORACLE;
pub use super::azure_subscription_id_invalid;
pub use super::provider_token_required;

Modules§

whats_new

Constants§

ALIAS_EMPTY
ALIAS_PATTERN_CHARS
ALIAS_WHITESPACE
AWS_REGIONS_REQUIRED
AZURE_REGIONS_REQUIRED
BUILTIN_THEMES
CANCELLED
CUSTOM_THEMES
DESCRIPTION_CONTROL_CHARS
DONE
GCP_PROJECT_REQUIRED
HOSTNAME_WHITESPACE
IMPORT_NO_FILE
NO_HOSTS
NO_PROVIDERS
NO_SNIPPETS
NO_TOKEN
NO_TUNNELS
ORACLE_COMPARTMENT_REQUIRED
PASSWORD_EMPTY
PRESS_ENTER
PROVIDER_LIST
All supported provider slugs as a comma-separated string. Surfaced in unknown_provider and skipping_unknown_provider. Kept as a single const so adding a new provider only updates one place.
PROVIDER_URL_REQUIRES_HTTPS
Stderr line printed by purple provider add when the user-supplied URL does not start with https://. CLI-flavoured: tells the user to use the --no-verify-tls flag, distinct from the TUI variant which references a Verify TLS toggle.
PROXMOX_URL_REQUIRED
SCALEWAY_REGIONS_REQUIRED
Stderr line printed when purple provider add scaleway is missing --regions. Mirrors the Azure/GCP/Oracle pattern of including the concrete flag form in the message.
SPECIFY_TARGET
SYNC_FAILED
Single-word “failed.” status the CLI sync output appends when a provider fetch hit a hard error. Mirrors the trailing-status pattern used by syncing_start so the line reads Syncing X... failed..
SYNC_RESULT_PREFIX_DRY_RUN
SYNC_RESULT_PREFIX_LIVE
Per-host status prefixes for purple sync output. Indented two spaces so the result line aligns under the Syncing X... header. --dry-run mode prepends “Would have:” so the user knows nothing was written.
SYNC_SKIP_WRITE
USER_WHITESPACE
WARN_COMPARTMENT_NOT_USED
WARN_NO_VERIFY_TLS_NOT_USED
WARN_PROFILE_NOT_USED
WARN_PROJECT_NOT_USED
WARN_REGIONS_NOT_USED
WARN_URL_NOT_USED
WARN_VERIFY_TLS_NOT_USED

Functions§

add_label_collides_with_bare
add_requires_label
added_forward
alias_already_exists
Stderr line printed by purple add when the alias already exists. Tells the user the exact flag to fix it instead of just complaining.
beaming_up
done_multi
exited_with_code
forward_exists
forward_not_found
host_failed
host_not_found
host_separator
import_parse_failures
Stderr lines printed after purple import when some lines failed to parse or read. Use the singular/plural form via the count.
import_read_errors
included_host_read_only
invalid_label_flag
log_deleted
no_config_for
no_config_to_remove
no_forwards
no_hosts_with_tag
no_log_file
no_tunnels_for
operation_failed
password_removed
removed_config
removed_configs
removed_forward
running_snippet_on
save_config_failed
saved_config
servers_found
servers_found_with_failures
skipping_host
skipping_unknown_provider
Stderr line when iterating configured providers and one is unknown (e.g. config file references a since-removed provider). The sync continues with the remaining providers.
snippet_not_found
starting_tunnel
sync_error
sync_removed
sync_result
sync_skip_remove
sync_stale
syncing
syncing_start
One-shot “Syncing X… “ prefix without the cursor-clear/CR escapes. Used before progress callbacks start emitting overwrite-style updates, so the user sees something happening even if the provider is slow to produce the first progress event.
theme_set
tunnels_for
unknown_provider
Stderr line when the user passed --provider X for an unknown slug. Different from skipping_unknown_provider so each call site can evolve its wording without breaking the other.
vault_cert_signed
vault_config_update_warning
vault_no_role
vault_sign_failed
vault_sign_host_block_gone
Stderr line emitted by purple vault sign --all when a host block disappeared between the moment we enumerated it and the moment we tried to write its CertificateFile (rename, delete, race with another process). The cert is on disk; only the wiring is missing.
vault_signing_host
Rendered before the dot-progress (\u{2713} or error) on each per-host vault sign in the CLI bulk path. The trailing space is intentional — the success/fail glyph follows on the same line.
welcome