From acf5cbdee64f3f372fbec71182a3e9e6e9fcd649 Mon Sep 17 00:00:00 2001 From: miqui Date: Thu, 19 Nov 2026 08:35:50 -0500 Subject: [PATCH] Document profiles and ADAPT_PROFILE in the README Co-Authored-By: Claude Opus 5.5 --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) diff --git a/README.md b/README.md index de178d2..26bcbae 100644 --- a/README.md +++ b/README.md @@ -41,6 +41,28 @@ adapt whoami If the machine has no browser, use `adapt auth login --no-browser`. +## Profiles + +A profile stores an API URL, credentials, and a selected organization. +The default profile is `default`. + +Sign in to another profile with `--profile`: + +```sh +adapt --profile staging auth login --api-url https://platform.adaptstaging.com +``` + +To use a profile for every command in your shell, set `ADAPT_PROFILE`: + +```sh +export ADAPT_PROFILE=staging +adapt whoami +``` + +The `--profile` option overrides `ADAPT_PROFILE`. +List saved profiles with `adapt profiles`. +For more information, see the [CLI reference](docs/cli-reference.md#profiles-and-api-urls). + ## Use a temporary sandbox Open a shell: