Configure a CLI Profile
Persist the base URL or workspace id for a CLI profile so repetitive commands stop depending on long flag strings.
CLI In this interface
4 steps Steps
1 interfaces Available in
Use this path when
Profile configuration belongs in the local CLI profile, not in every repeated command invocation.
What you'll finish here
- Persist stable defaults.
- Clear stale local state when needed.
- Reduce operator error in repetitive flows.
Where this happens
Do the work
- 1. Store the base URL once with `./backlog.sh config set-base-url <url>` if you use the same environment repeatedly.
- 2. Store the workspace id with `./backlog.sh config set-workspace <workspaceId>` if you run workspace-scoped admin commands often.
- 3. Use `config clear-workspace` when the stored workspace id is the only stale value.
- 4. Use `config clear` when the whole profile should be reset to a clean state.
Keep Going in CLI Setup
Stay in the same interface and move to the next closest task in this topic when needed.
CLI CLI Setup
Download the CLI
Download the standalone Backlog CLI script from `https://backlog.to/backlog.sh` and make it executable locally.
4 steps ยท 1 examples
CLI CLI Setup
Check CLI Status
Inspect the active CLI profile, token source, and workspace defaults before you run commands.
4 steps
CLI CLI Setup
Set the Active CLI Token
Switch the CLI into the right token mode before you run resource or admin commands.
4 steps
Nearby Guides
These guides stay close to the current workflow so you can keep moving without restarting discovery.