x umami

umami 的 CLI

TIP

Umami Cloud 私人令牌获取: https://umami.is/docs/cloud/api-key

• 交互环境中可使用 x umami init 进行初始化配置，配置信息将存放于本地保存
• 亦可运行命令 x umami --cfg token=<token> 添加私人令牌
• V2 API 端点: https://api.umami.is (云端) 或 http://<自托管>/api (自托管 v2)

例子

列出所有网站（默认交互表格）

x umami site ls

以 CSV格式列出网站

x umami site ls --csv

以 TSV格式列出网站

x umami site ls --tsv

以 JSON格式列出网站

x umami site ls --json

以 YAML格式列出网站

x umami site ls --yml

创建网站

x umami site create mysite example.com

获取网站统计（浏览量、访客等）

x umami site stat x-cmd

获取网站统计（JSON格式）

x umami site stat x-cmd --json

获取页面浏览量

x umami site pv x-cmd

按天查看页面浏览量

x umami site pv x-cmd --unit day

获取当前活跃用户数

x umami site active x-cmd

获取URL访问排行

x umami site metric x-cmd --type url

获取国家分布

x umami site metric x-cmd --type country

获取浏览器统计

x umami site metric x-cmd --type browser

获取操作系统统计

x umami site metric x-cmd --type os

获取设备统计

x umami site metric x-cmd --type device

获取来源统计

x umami site metric x-cmd --type referrer

获取网站事件列表

x umami site event x-cmd

重置网站（删除所有数据）

x umami site reset x-cmd

获取事件数据

x umami event ls x-cmd

获取事件字段统计

x umami event field x-cmd

获取事件汇总统计

x umami event stat x-cmd

获取会话统计

x umami session stat x-cmd

获取当前用户信息

x umami me ls --me

获取用户团队列表

x umami me ls --teams

获取用户网站列表

x umami me ls --websites

配置 token 和 endpoint

x umami --cfg set token=<your-token> endpoint=<endpoint>

查看当前配置

x umami --cur

交互式初始化配置

x umami init

在团队下创建网站

x umami site create mysite example.com --teamId <team-id>

子命令

名称	描述
x umami cfg	管理 umami 模块配置
x umami cur	管理当前会话的 umami 模块配置
x umami init	使用交互式表单初始化配置
x umami site	进行管理和统计网站的操作
x umami event	获取 event 数据
x umami me	获取当前用户相关信息
x umami session	会话相关操作

TIP

在交互式终端中（如 zsh, bash ...），可以使用 Tab 获取补全信息

运行 CMD SUBCOMMAND --help 可以获取命令的更多信息