You start with a default profile
A fresh install ships with a ready-to-usedefault profile pointed at a local
agent. So if you run the agent on your machine
with formae agent start, the CLI already reaches it, with no profile setup at
all. See what you have:
*; on a clean install that is default.
Edit the default profile
To point the default profile somewhere else, or add settings, open it in your editor:edit opens the active profile. A profile is a Pkl file; its
cli.api.url is the agent endpoint the CLI connects to (a local agent by
default).
Create a profile for another environment
Once you have more than one environment (say a local agent and a bootstrapped one in AWS), give each its own profile:create starts from a minimal template; edit opens it so you can set the agent
URL and any other settings. When you
install an agent with bootstrap, the
installer writes this profile for you.
Switch between environments
One profile is active at a time, and it applies to every command that connects to the agent (apply, destroy, status, inventory, and the rest). Switch it
with:
--profile:
--profile is mutually exclusive with --config: a profile is a config source,
so passing both is an error.
Where profiles live
Profiles are stored as Pkl files under~/.config/formae/profiles/<name>.pkl
(honoring $XDG_CONFIG_HOME and $FORMAE_CONFIG_DIR). The active profile is
recorded in a plain-text active file alongside them. Existing setups are
migrated into this layout automatically the first time you run a command that
needs configuration.
Command reference
list and current accept --output-consumer machine (with
--output-schema json|yaml) for scripting.
See also
- Install and run the agent: the installer writes a profile for your new agent.
- Configuration: the settings a profile holds.