Configure and revert a client

Check client compatibility and confirm configure appears in the installed CLI's unlimgpt --help output first. The compatibility matrix identifies each client's current mode; guided instructions require changes in the client's own settings. Have access to the intended organization, an available operating-system credential store and the client's own configuration before applying a plan.

Choose a setup mode

If you belong to multiple organizations and your installed release supports organizations, select the organization for the current profile:

unlimgpt organizations list
unlimgpt organizations use ORGANIZATION_ID

The server validates your selection. Switching organizations clears the profile's selected key without revoking earlier keys or removing their stored secrets. Configure the client again for the selected organization.

An automatic plan writes only the CLI-owned client settings after confirmation. Secure launch supplies a credential to a child process without putting it in its config file. Guided setup gives steps for the client's own settings screen; the user completes them there. For any mode, select a model ID available to your key rather than a display name. If you use Codex Desktop, quit it before applying or reverting Codex configuration so its local conversation state is not changed concurrently.

Preview and apply

unlimgpt configure codex --dry-run
unlimgpt configure codex

Dry run changes no files, credentials or sign-in state. It prints the destination and each field that would be added, replaced or removed. Untouched settings stay out of the preview, and a replaced field's previous value is not printed. The plan selects UnlimGPT as the top-level model_provider and replaces the top-level model, while retaining other TOML settings. The apply command may sign in, create a dedicated API key and store it securely if the active profile has no usable key. It writes supported client settings only after confirmation. Automatic changes print one or more guarded revert receipts; guided setup prints manual steps and may ask you to paste a key into the client's native secret field. It does not mean the external client was configured automatically. Treat a clipboard copy as a secret and clear it after setup.

Verify and undo

If the installed release supports models, first run unlimgpt models to check key access without paid generation. Then open the client and send one short request using an available model. That request may consume credits; check its outcome in API Activity. If a configuration problem remains, run doctor. To restore only a change still owned by this CLI:

unlimgpt configure revert RECEIPT_ID

Use the receipt printed by the apply step; a guided setup without a file edit has no receipt to revert. Revert refuses to overwrite later third-party edits. It does not revoke the API key, so review its use and revoke it separately if it is no longer needed. A failed apply may already have created a key or receipt: inspect the command's safe outcome and API key list before retrying. Keep unrelated client settings and the receipt safe. Next: key lifecycle.