Back to Details

omni-content-explorer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Omni Content Explorer

Omni内容探索器

Find, browse, and organize Omni content — dashboards, workbooks, and folders — through the Omni CLI.
使用Omni CLI查找、浏览和管理Omni内容——包括仪表板（dashboards）、工作簿（workbooks）和文件夹（folders）。

Prerequisites

前提条件

bash
undefined
bash
undefined

Verify the Omni CLI is installed — if not, ask the user to install it

验证Omni CLI是否已安装——若未安装，请提示用户安装

See: https://github.com/exploreomni/cli#readme

参考：https://github.com/exploreomni/cli#readme

command -v omni >/dev/null || echo "ERROR: Omni CLI is not installed."

```bash
command -v omni >/dev/null || echo "ERROR: Omni CLI is not installed."

```bash

Show available profiles and select the appropriate one

查看可用配置文件并选择合适的配置文件

omni config show
omni config show

If multiple profiles exist, ask the user which to use, then switch:

若存在多个配置文件，请询问用户使用哪个，然后切换：

omni config use <profile-name>
undefined
omni config use <profile-name>
undefined

Discovering Commands

命令探索

bash
omni content --help     # Content operations
omni documents --help   # Document operations
omni folders --help     # Folder operations
Tip: Use 
-o json
to force structured output for programmatic parsing, or 
-o human
for readable tables. The default is 
auto
(human in a TTY, JSON when piped).
bash
omni content --help     # 内容操作
omni documents --help   # 文档操作
omni folders --help     # 文件夹操作
提示：使用
-o json
强制输出结构化内容以用于程序解析，或使用
-o human
输出易读的表格。默认模式为
auto
（在终端中输出人类可读格式，管道传输时输出JSON格式）。

Browsing Content

内容浏览

List All Content

列出所有内容

bash
omni content list
bash
omni content list

With Counts and Labels

包含数量与标签

bash
omni content list --include '_count,labels'
bash
omni content list --include '_count,labels'

Filter and Sort

筛选与排序

bash
undefined
bash
undefined

By label

按标签筛选

omni content list --labels finance,marketing
omni content list --labels finance,marketing

By scope

按范围筛选

omni content list --scope organization
omni content list --scope organization

Sort by popularity or recency

按热度或更新时间排序

omni content list --sortfield favorites
omni content list --sortfield updatedAt
undefined
omni content list --sortfield favorites
omni content list --sortfield updatedAt
undefined

Pagination

分页

Responses include 
pageInfo
with cursor-based pagination. Fetch next page:
bash
omni content list --cursor <nextCursor>
响应结果包含带有游标分页的
pageInfo
。获取下一页：
bash
omni content list --cursor <nextCursor>

Working with Documents

文档操作

List Documents

列出文档

bash
omni documents list
bash
omni documents list

Filter by creator

按创建者筛选

omni documents list --creatorid <userId>

Each document includes: `identifier`, `name`, `type`, `scope`, `owner`, `folder`, `labels`, `updatedAt`, `hasDashboard`.

> **Important**: Always use the `identifier` field for API calls, not `id`. The `id` field is null for workbook-type documents and will cause silent failures.
omni documents list --creatorid <userId>

每个文档包含以下字段：`identifier`、`name`、`type`、`scope`、`owner`、`folder`、`labels`、`updatedAt`、`hasDashboard`。

> **重要提示**：API调用请始终使用`identifier`字段，而非`id`字段。工作簿类型文档的`id`字段为null，使用该字段会导致静默失败。

Get Document Queries

获取文档查询语句

Retrieve query definitions powering a dashboard's tiles:
bash
omni documents get-queries <identifier>
Useful for understanding what a dashboard computes and re-running queries via 
omni-query
.
检索驱动仪表板组件的查询定义：
bash
omni documents get-queries <identifier>
此命令有助于理解仪表板的计算逻辑，并可通过
omni-query
重新运行查询。

Folders

文件夹操作

bash
undefined
bash
undefined

List

列出文件夹

omni folders list
omni folders list

Create

创建文件夹

omni folders create "Q1 Reports" --scope organization
undefined
omni folders create "Q1 Reports" --scope organization
undefined

Labels

标签操作

bash
undefined
bash
undefined

List labels

列出标签

omni labels list
omni labels list

Add label to document

为文档添加标签

omni documents add-label <identifier> <labelName>
omni documents add-label <identifier> <labelName>

Remove label

移除文档标签

omni documents remove-label <identifier> <labelName>
undefined
omni documents remove-label <identifier> <labelName>
undefined

Favorites

收藏操作

bash
undefined
bash
undefined

Favorite

收藏文档

omni documents add-favorite <identifier>
omni documents add-favorite <identifier>

Unfavorite

取消收藏文档

omni documents remove-favorite <identifier>
undefined
omni documents remove-favorite <identifier>
undefined

Dashboard Downloads

仪表板下载

bash
undefined
bash
undefined

Start download (async)

启动下载（异步）

omni dashboards download <dashboardId> --body '{ "format": "pdf" }'
omni dashboards download <dashboardId> --body '{ "format": "pdf" }'

Poll job status

查询任务状态

omni dashboards download-status <dashboardId> <jobId>

Formats: `pdf`, `png`
omni dashboards download-status <dashboardId> <jobId>

支持格式：`pdf`、`png`

URL Patterns

URL格式

Construct direct links to content:
Dashboard: {OMNI_BASE_URL}/dashboards/{identifier}
Workbook:  {OMNI_BASE_URL}/w/{identifier}
The 
identifier
comes from the document's 
identifier
field in API responses. Always provide the user a clickable link after finding content.
构建内容的直接链接：
Dashboard: {OMNI_BASE_URL}/dashboards/{identifier}
Workbook:  {OMNI_BASE_URL}/w/{identifier}
identifier
来自API响应中的文档
identifier
字段。找到内容后，请始终为用户提供可点击的链接。

Search Patterns

搜索模式

When scanning all documents for field references (e.g., for impact analysis), paginate with cursor and call 
omni documents get-queries <identifier>
for each document. Launch multiple query-fetch calls in parallel for efficiency. For field impact analysis, prefer the content-validator approach in 
omni-model-explorer
.
当扫描所有文档查找字段引用（例如用于影响分析）时，使用游标分页并为每个文档调用
omni documents get-queries <identifier>
。为提高效率，可并行发起多个查询获取请求。对于字段影响分析，建议使用
omni-model-explorer
中的内容验证器方案。

Docs Reference

文档参考

Related Skills

相关技能

  • omni-query — run queries behind dashboards you've found
  • omni-content-builder — create or update dashboards
  • omni-embed — embed dashboards you've found in external apps
  • omni-admin — manage permissions on documents and folders
  • omni-query — 运行你找到的仪表板背后的查询
  • omni-content-builder — 创建或更新仪表板
  • omni-embed — 将找到的仪表板嵌入外部应用
  • omni-admin — 管理文档和文件夹的权限