deepvista-shared

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

DeepVista CLI — Shared Reference

DeepVista CLI — 共享参考

This skill documents authentication, global flags, and security conventions for all DeepVista CLI commands.

本Skill记录了所有DeepVista CLI命令的身份验证、全局标志和安全规范。

Installation

安装

deepvista

is not already installed, install it with any of:

bash

undefined

如果尚未安装

deepvista

，可通过以下任意方式安装：

bash

undefined

From PyPI

从PyPI安装

pip install deepvista-cli

From GitHub (latest)


With uv or pipx:

```bash
uv tool install deepvista-cli
pipx install deepvista-cli

Verify:

bash

deepvista --version

pip install git+https://github.com/DeepVista-AI/deepvista-cli.git


也可使用uv或pipx安装：

```bash
uv tool install deepvista-cli
pipx install deepvista-cli

验证安装：

bash

deepvista --version

Running Commands

运行命令

bash

deepvista [GLOBAL FLAGS] <service> <command> [options]

If running from the cloned repo without installing, prefix commands with

uv run

IMPORTANT: Global flags like

--profile

must come BEFORE the service name:

bash

undefined

bash

deepvista [全局标志] <服务> <命令> [选项]

如果是克隆仓库后未安装直接运行，需要在命令前加上

uv run

前缀。

重要提示： 类似

--profile

的全局标志必须放在服务名称之前：

bash

undefined

Correct:

正确写法：

deepvista --profile local notes list

WRONG — will fail:

错误写法 —— 会执行失败：

deepvista notes list --profile local

undefined

deepvista notes list --profile local

undefined

Profiles

配置文件（Profiles）

The CLI uses profiles to connect to different backends. Use

--profile local

for local development:

bash

deepvista --profile local <service> <command>

List available profiles:

bash

deepvista config list

CLI使用配置文件连接不同的后端环境。本地开发时请使用

--profile local

：

bash

deepvista --profile local <服务> <命令>

列出可用的配置文件：

bash

deepvista config list

Authentication

身份验证

bash

undefined

bash

undefined

Step 1: Open browser login page

步骤1：打开浏览器登录页面

deepvista auth login

Step 2: Copy the command shown in the browser and paste it:

步骤2：复制浏览器中显示的命令并粘贴执行：

deepvista auth login --code <base64_code>

Check auth state

查看身份验证状态

deepvista auth status

Logout

登出

deepvista auth logout

undefined

deepvista auth logout

undefined

CLI Syntax

CLI语法

deepvista [--profile NAME] <service> <command> [options]
deepvista [--profile NAME] <service> +<helper> [args] [options]

Services:

auth

config

vistabase

vistabook

notes

chat

deepvista [--profile 配置名] <服务> <命令> [选项]
deepvista [--profile 配置名] <服务> +<辅助命令> [参数] [选项]

支持的服务：

auth

config

vistabase

vistabook

notes

chat

Global Flags

全局标志

Global flags go BEFORE the service name.

Flag	Default	Description
`--profile NAME`	`default`	Config profile to use (e.g. `local` , `staging` ).
`--format json\|table`	`json`	Output format. JSON is default (agent-friendly).
`--verbose`	off	Show HTTP request/response details on stderr.
`--dry-run`	off	Show what would be sent without executing.
`--api-url URL`	—	Override backend URL.
`--version`	—	Show version and exit.
`--help`	—	Show help for any command.

全局标志必须放在服务名称之前。

标志	默认值	说明
`--profile 配置名`	`default`	要使用的配置文件（例如 `local` 、 `staging` ）。
`--format json\|table`	`json`	输出格式。默认输出JSON（对Agent更友好）。
`--verbose`	关闭	在标准错误流中展示HTTP请求/响应详情。
`--dry-run`	关闭	仅展示将发送的内容，不实际执行命令。
`--api-url 地址`	—	覆盖后端请求地址。
`--version`	—	显示版本号后退出。
`--help`	—	查看任意命令的帮助信息。

Output Format

输出格式

JSON (default): Structured JSON to stdout. Agents should parse this.
Table: Human-readable table on stderr + JSON on stdout.

Errors:

{"error": {"code": N, "message": "...", "detail": "..."}}

on stderr.

Streaming (chat, vistabook +run): NDJSON — one JSON object per line.

JSON（默认）：向标准输出流输出结构化JSON，Agent应解析该格式。
表格：向标准错误流输出人类可读的表格，同时向标准输出流输出JSON。

错误：向标准错误流输出

{"error": {"code": 错误码, "message": "...", "detail": "..."}}

格式内容。

流式输出（chat、vistabook +run场景）：NDJSON格式 —— 每行一个JSON对象。

Exit Codes

退出码

Code	Meaning
0	Success
1	API error (backend returned error)
2	Auth error (not logged in / token expired)
3	Validation error (bad arguments)
4	Network error (cannot reach backend)
5	Internal error

码值	含义
0	执行成功
1	API错误（后端返回错误）
2	身份验证错误（未登录/令牌过期）
3	参数校验错误（参数非法）
4	网络错误（无法连接后端）
5	内部错误

Self-Discovery

自助查询

Every command supports

--help

bash

deepvista --help
deepvista vistabase --help
deepvista vistabase +search --help

所有命令都支持

--help

参数查看帮助：

bash

deepvista --help
deepvista vistabase --help
deepvista vistabase +search --help

Security Rules

安全规则

Write commands are marked with
```
> [!CAUTION]
```
— always confirm with the user before executing write/delete operations.
Read-only commands are safe to run without confirmation.
Never output tokens or secrets — use
```
deepvista --profile local auth status
```
to check auth state.
Use
--dry-run
to preview destructive operations before executing.
Tokens are sensitive — stored in
```
~/.config/deepvista/credentials.json
```
(mode 0600).

写入类命令会标记
```
> [!CAUTION]
```
—— 执行写入/删除操作前必须向用户确认。
只读类命令无需确认即可安全运行。
切勿输出令牌或密钥 —— 可使用
```
deepvista --profile local auth status
```
检查身份验证状态。
**执行破坏性操作前使用
```
--dry-run
```
**预览操作内容。
令牌属于敏感信息 —— 存储在
```
~/.config/deepvista/credentials.json
```
（权限为0600）。

deepvista-shared

Original

Translation

DeepVista CLI — Shared Reference

DeepVista CLI — 共享参考

Installation

安装

From PyPI

从PyPI安装

From GitHub (latest)

从GitHub安装（最新版本）

Running Commands

运行命令

Correct:

正确写法：

WRONG — will fail:

错误写法 —— 会执行失败：

Profiles

配置文件（Profiles）

Authentication

身份验证

Step 1: Open browser login page

步骤1：打开浏览器登录页面

Step 2: Copy the command shown in the browser and paste it:

步骤2：复制浏览器中显示的命令并粘贴执行：

Check auth state

查看身份验证状态

Logout

登出

CLI Syntax

CLI语法

Global Flags

全局标志

Output Format

输出格式

Exit Codes

退出码

Self-Discovery

自助查询

Security Rules

安全规则

See Also

相关参考