[ PROMPT_NODE_23584 ]
neon-cli
[ SKILL_DOCUMENTATION ]
# Neon CLI
Neon CLI 是一个命令行界面,用于直接从终端管理 Neon Serverless Postgres。它提供了与 Neon 平台 API 相同的功能,非常适合脚本编写、CI/CD 流水线以及偏好终端工作流的开发者。
## 安装
**macOS (Homebrew):**
bash
brew install neonctl
**npm (跨平台):**
bash
npm install -g neonctl
**直接下载:**
bash
curl -fsSL https://neon.tech/install.sh | bash
## 身份验证
使用您的 Neon 账户进行身份验证:
bash
neonctl auth
这将打开浏览器进行 OAuth 认证并将凭据存储在本地。
对于 CI/CD 或非交互式环境,请使用 API 密钥:
bash
export NEON_API_KEY=your-api-key
从此处获取您的 API 密钥:https://console.neon.tech/app/settings/api-keys
## 常用命令
### 项目管理
bash
# 列出所有项目
neonctl projects list
# 创建新项目
neonctl projects create --name my-project
# 获取项目详情
neonctl projects get
# 删除项目
neonctl projects delete
### 分支操作
bash
# 列出分支
neonctl branches list --project-id
# 创建分支
neonctl branches create --project-id --name dev
# 删除分支
neonctl branches delete --project-id
### 连接字符串
bash
# 获取连接字符串
neonctl connection-string --project-id
# 获取特定分支的连接字符串
neonctl connection-string --project-id --branch-id
# 获取连接池字符串
neonctl connection-string --project-id --pooled
### SQL 执行
bash
# 运行 SQL 查询
neonctl sql "SELECT * FROM users LIMIT 10" --project-id
# 从文件运行 SQL
neonctl sql --file schema.sql --project-id
### 数据库管理
bash
# 列出数据库
neonctl databases list --project-id --branch-id
# 创建数据库
neonctl databases create --project-id --name mydb
# 列出角色
neonctl roles list --project-id --branch-id
## 输出格式
CLI 支持多种输出格式:
bash
# JSON 输出 (脚本默认)
neonctl projects list --output json
# 表格输出 (人类可读)
neonctl projects list --output table
# YAML 输出
neonctl projects list --output yaml
## CI/CD 集成
GitHub Actions 示例 w