byteplan-cli

BytePlan CLI - Command line tool for BytePlan API.

Installation

npm install -g byteplan-cli

Usage

Login

登录并保存凭据（一次登录，后续无需重复）：

# 首次登录（需要提供账号密码）
byteplan login -u <phone> -p <password>

# 使用已保存的凭据刷新 Token（无需账号密码）
byteplan login

# 覆盖已有凭据（直接传新账号密码即可）
byteplan login -u <new_phone> -p <new_password>

Config

检查当前配置状态：

byteplan config

输出示例：

{
  "configured": true,
  "user": "18256485741",
  "env": "uat",
  "hasToken": true,
  "tokenExpired": false,
  "message": "Configuration is valid."
}

User Commands

# Get user info
byteplan user info

# List available tenants
byteplan user tenants

Model Commands

# List models
byteplan model list

# Get model columns
byteplan model columns <modelCode>

Data Commands

# Query data
byteplan data query <modelCode>

Skills Commands

BytePlan CLI 提供了一系列 Skills，可以安装到多个 AI CLI 平台。

命令列表：

# 查看可用的 Skills
byteplan skills list

# 安装所有 Skills
byteplan skills install -p claude-code

# 查看已安装的 Skills
byteplan skills installed -p claude-code

支持的平台：

| Platform | 目录 | |----------|------| | claude-code (alias: claude) | ~/.claude/commands | | codex | ~/.codex | | openclaw | ~/.openclaw/skills |

安装示例：

# 安装到单个平台
byteplan skills install -p claude-code

# 安装到多个平台
byteplan skills install -p claude-code,codex,openclaw

# 使用自定义目录
byteplan skills install -d ~/.claude/commands

Windows 用户：~ 路径会自动展开，也可使用 %USERPROFILE% 环境变量。

Options

• -e, --env <environment> - Environment (uat, prod), default: uat

Configuration

byteplan login 会将凭据持久化保存到 ~/.byteplan/.env，后续命令无需重复登录。

保存的内容：

BP_ENV=uat                      # 环境 (uat/prod)
BP_USER=<phone>                 # 手机号（用于自动重登）
BP_PASSWORD=<password>          # 密码（用于自动重登）
ACCESS_TOKEN=<token>            # 当前访问令牌
REFRESH_TOKEN=<refresh_token>   # 刷新令牌
TOKEN_EXPIRES_IN=<timestamp>    # Token 过期时间戳

Token 自动刷新：

• Token 有效期默认 2 小时
• CLI 检测到 Token 即将过期（剩余 < 5 分钟）时，会自动用保存的账号密码重新登录
• 无需手动干预，命令会自动执行

安全性说明：

• 凭据以明文存储在本地 .env 文件中
• 请勿在共享环境中使用，或确保 ~/.byteplan/ 目录权限受限
• 如需清除凭据：rm ~/.byteplan/.env

License

MIT