cbi-shared

Original：🇨🇳 Chinese

Translated

CreatiBI CLI Shared Basics: Application configuration initialization, authentication login (auth login), identity check (auth whoami). Triggered when users need to configure for the first time, use login authorization, encounter insufficient permissions, or use cbi-cli for the first time.

3installs

Sourcecreatibi/cli

Added on2026-04-26

NPX Install

npx skill4agent add creatibi/cli cbi-shared

SKILL.md Content (Chinese)

View Translation Comparison →

CreatiBI CLI Basic Configuration and Authentication

Initialization and authentication module of the CreatiBI command-line tool.

Installation

bash

# npm installation (recommended)
npm install -g @creatibi/cbi-cli@latest

# Or use npx (no installation required)
npx @creatibi/cbi-cli --help

Supported platforms: macOS (amd64/arm64), Linux (amd64/arm64), Windows (amd64/arm64)

Quick Start

bash

# 1. Initialize configuration (for first use)
cbi config init

# 2. OAuth login
cbi auth login

# 3. Confirm login success
cbi auth whoami

Quick Reference for Common Commands

Scenario	Command
Initialize configuration	`cbi config init`
Force re-initialization	`cbi config init --new`
View configuration	`cbi config show`
Login authorization	`cbi auth login`
Check current identity	`cbi auth whoami`
Logout	`cbi auth logout`

Configuration Module (config)

Initialize Configuration

Initialization of application credential configuration is required for first use:

bash

# Initialize configuration (interactive input)
cbi config init

# Force re-initialization (overwrite existing configuration)
cbi config init --new

Process:

Check if configuration already exists
If it exists, use
```
--new
```
to force overwrite
Guide users to enter application credential information:
- ```
client_id
```
  (Application ID) - Required
- ```
client_secret
```
  (Application Secret) - Required
- ```
base_url
```
  (default https://open.creatibi.cn)
- ```
default_workspace
```
  (optional)
Configuration is written to
```
~/.cbi/config.json
```

Prerequisite: Create an application on the CreatiBI Open Platform to obtain client_id and client_secret

Show Current Configuration

bash

cbi config show              # Show configuration (sensitive fields desensitized)
cbi config show -v           # Verbose mode (show login credentials)
cbi config show --format json   # Output in JSON format

Authentication Module (auth)

OAuth Login

bash

cbi auth login

Prerequisite: Executed

cbi config init

to configure application credentials

Process:

CLI starts a local callback server (port 8080)
Automatically opens the browser to access the authorization page
Users complete authorization in the browser
The server callbacks to the CLI and returns an authorization code
CLI exchanges the authorization code for access_token
Token is stored in ~/.cbi/config.json

Check Current Identity

bash

cbi auth whoami      # Check current logged-in identity
cbi auth whoami -v   # Verbose mode (show token information)

Logout

bash

cbi auth logout

Error Handling

Insufficient Permissions/Not Logged In

When encountering

permission denied

or

auth required

errors:

bash

# 1. Check if configuration exists
cbi config show

# 2. If configuration does not exist, initialize first
cbi config init

# 3. Login authorization
cbi auth login

# 4. Confirm login success
cbi auth whoami

Token Expired

When encountering

expired access token

errors:

bash

cbi auth login   # Log in again

Configuration File Issues

bash

cbi config init --new   # Force re-initialization of configuration
cbi auth login          # Log in again

Configuration File Location

Configuration is stored in

~/.cbi/config.json

:

json

{
  "base_url": "https://open.creatibi.cn",
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "api_key": "YOUR_ACCESS_TOKEN",
  "refresh_token": "YOUR_REFRESH_TOKEN",
  "token_expires_at": "2026-04-24T00:28:54Z"
}

General Parameters

Parameter	Description
`--config <path>`	Configuration file path (default ~/.cbi/config.json)
`-f, --format`	Output format: json / table
`-v, --verbose`	Show detailed information

cbi-shared

NPX Install

Tags

SKILL.md Content (Chinese)

CreatiBI CLI Basic Configuration and Authentication

Installation

Quick Start

Quick Reference for Common Commands

Configuration Module (config)

Initialize Configuration

Show Current Configuration

Authentication Module (auth)

OAuth Login

Check Current Identity

Logout

Error Handling

Insufficient Permissions/Not Logged In

Token Expired

Configuration File Issues

Configuration File Location

General Parameters