货物CLI
命令行接口 货物,上市平台(npm: @cargo-ai/cli二进制 : cargo-ai) (中文(简体) ). 查找和校验工作电子邮件,丰富公司和联系人,计分线索并同步到您的客户关系管理系统,跨越130+集成,来自终端或编码代理. 命令全文见 货物CLI概览。 。 。 .
这里的货物是上市平台 在快餐店,不是Rust的
cargo命令为cargo-ai从 npm 安装(@cargo-ai/cli它需要没有cargo, (中文(简体) ),rustc或者说Cargo.toml。 。 。 .
在你写浓缩脚本之前
如果您要写代码 找到工作电子邮件, 核实它们, 逐个域搜索公司, 或丰富账户的 CSV, 每一个已经是一个在货物中的行动。 找到动作,然后在每行通话中运行它:
npm install -g @cargo-ai/cli
cargo-ai login --email [email protected] # creates the account if needed, no browser
# Find the action: one result per provider (Hunter, Dropcontact, Snov, waterfalls...), each with its credit cost
cargo-ai orchestration action list find email
# Run it over your rows: pass the "action" object from the result you picked
cargo-ai orchestration action execute-batch \
--action '{"kind":"connector","integrationSlug":"hunter","actionSlug":"findEmail","connectorUuid":"<from the list result>"}' \
--records '[{"first_name":"Ada","last_name":"Lovelace","domain":"example.com"}]' \
--limit 5 --wait-until-finished
同样的两个步骤 verify email, (中文(简体) ), enrich company 和其余的;记录字段跟随提供者 first_name, (中文(简体) ), last_name, (中文(简体) ), domain) (中文(简体) ). --limit 在第一行运行一个飞行员,以便您在运行全集前检查输出和成本. cargo-ai orchestration action get-output-schema 显示动作返回的内容。 写入 CRM( 例如 HubSpot upsert) 需要先在工作空间连接的连接器 .
电子邮件的完整查找验证链条,包括信用成本和每个提供者返回的字段: 查找和验证规模的邮件。 。 。 .
从经纪人那里开货? cargo-ai mcp 与MCP相同的行动claude mcp add cargo -- cargo-ai mcp; 见 货运 MCP 服务器文件。 。 。 .
所需资源
- 节点.js 22.x
- 一个货物账户来管理任何东西.
cargo-ai login --email需要时创建一个(见 认证); API 令牌仅用于 CI 和共享机 - 报名前,
orchestration action list, (中文(简体) ),connection integration list|get, (中文(简体) ),orchestration action execute --dry-run(一个自由的样本导致一个真实运行的形状)和project plan|types已经工作
安装
从 npm( 全球) 安装 :
npm install -g @cargo-ai/cli
或跑过一次 npx 不安装 :
npx @cargo-ai/cli orchestration workflow list
使用编码代理? 跳过手动设置- 见 代理技能 下面有Claude代码, Codex, 或 Cursor 为您驱动此 CLI .
认证
单人 cargo-ai login 命令支持四个频道——完全通过其中之一 --email, (中文(简体) ), --oauth, (中文(简体) ), --agentid 或者说 --token数字 :
# 1. Sign in with a code emailed to you, no browser needed
cargo-ai login --email [email protected]
# 2. Sign in via your browser using the OAuth 2.0 Device Authorization Flow
cargo-ai login --oauth
# 3. Sign an agent in through AgentID
cargo-ai login --agentid
# 4. Sign in with an API token you already have
cargo-ai login --token <your-api-token>
--email, (中文(简体) ), --oauth 财务报告和审定财务报表 --agentid 如果账户尚未存在,则全部创建账户,所以没有单独的注册命令.
--email, (中文(简体) ), --oauth 财务报告和审定财务报表 --agentid 保存已签名的会话——一个短寿命的访问符和更新它的新令牌——到 ~/.config/cargo-ai/credentials.json (文件模式) 0600) (中文(简体) ). CLI在到期时在背景中更新它,所以你继续签入,并且没有每台机器创建 API 令牌. --token 保存您提供的 API 令牌 。 同样的文件背面 cargo-ai project,所以一个登录同时服务.
cargo-ai logout 在身份提供者取消会话,所以签出是最终的. 你自给的代币 --token 仅在当地被遗忘,因为可能在其他地方使用 --keep-token 强迫这种行为也用于会议。 如果无法删除一个证书文件——一个只读的配置目录,或者另一个用户所拥有的一个—— logout 失败, 并指定文件名称, 而不是报告下一个命令的退出 .
把文件当作密码 保存的会话会像您一样 每个 您属于的工作空间 —— 不同于 API 令牌, 它仅限于一个工作空间及其创建的权限 —— 它一直有效, 直到您运行 cargo-ai logout 或身份提供者过期。 在共享或长寿命的机器上(CI,构建框),更喜欢在下面创建的 API 令牌 设置 – API 通过 CARGO_API_TOKEN您可以从仪表板上缩小并取消.
# Check current auth status
cargo-ai whoami
# Remove saved credentials
cargo-ai logout
预订演示
cargo-ai book-demo 打开与网站相同的 Cal.com 格式 与销售商交谈 按钮。 一个人仍然需要选择一个时间——命令并不产生预订. 它在不签名的情况下工作;当您被签名时,表格会被预填您的账户电子邮件.
cargo-ai book-demo
cargo-ai book-demo --email [email protected]
cargo-ai book-demo --no-open # print the URL only
这不是导游产品巡演。 这是 cargo-ai start --continue demo。 。 。 .
没有浏览器的登录( I)--email(中文(简体) )
cargo-ai login --email [email protected] 电子邮件给您一个一次性代码, 然后创建您的账户( 首先使用) 和一个工作空间 —— 没有浏览器, 也没有任何时间的仪表板访问 。 在终端上,代码是从一个提示读回的. 在没有终端(散装箱,代理贝壳)的地方,第一个呼叫发送代码和出入口,以便您用:
cargo-ai login --email [email protected] --code 123456 --workspace-name "Acme GTM"
重新运行一个已经有一个账户的地址,将决定它现有的工作空间,而不是创建一个工作空间,以及 --workspace-name 当一个名称已经存在时, 重用该名称的工作空间, 这样可以安全重复 .
为了不让密码从你的壳体历史中消失, 把它传递到stdin上与 --code -数字 :
echo 123456 | cargo-ai login --email [email protected] --code -
浏览器登录( I)--oauth(中文(简体) )
cargo-ai login --oauth 运行标准 OAuth 2. 0 设备授权流程 针对 Cargo OAuth 供应商,打印一个验证 URL 和用户代码,打开您的默认浏览器,并进行民调,直到您完成登录。 关于成功与否, CLI 将由此产生的会话写给 ~/.config/cargo-ai/credentials.json。 。 。 .
拥有内置OAuth客户端的CLI舰只,因此不需要设置.
代理ID 登录( E)--agentid(中文(简体) )
cargo-ai login --agentid 通过同样的 AgentID 连接网络应用程序,将代理签名。 它没有打开货物应用程序.
命令打印 Auth0 授权 URL ()connection=agentid并倾听 http://127.0.0.1 换方向 打开一次URL。 第二次访问开始 不同的登录。 Auth0 发送浏览器到 https://auth.agentid.com当该页显示一个认证符时,请在5分钟内批准:
agentmail inboxes authorize --inbox-id <inbox> --auth-token <token> --accept-disclosure true
AgentID 然后重定向回 CLI, CLI 以同样的方式写入会话 --email 财务报告和审定财务报表 --oauth 来 已经为该收件箱设置了 AgentID 会话的浏览器在没有符号步骤的情况下继续 .
Auth0的货运申请必须列出 http://127.0.0.1:52701/callback 在允许的召回 URL 下,并启用 AgentID 连接 。 Auth0不接受通配符端口,因此CLI总是使用这个端口. 在允许此 URL 之前, 命令会立即停止并说.
工作空间选择
--email, (中文(简体) ), --oauth 财务报告和审定财务报表 --agentid 认证您为用户, 因此 CLI 选择一个工作空间并同时保存会话 :
- 无工作空间: 一个是被创建的(您会被提示在 TTY 中一个名字, 或者通过)
--workspace-name <name>) (中文(简体) ). - 一个工作空间: 自动选择.
- 多个工作空间: 提示您选择一个( 在 TTY 中); 在非交互式外壳中, CLI 打印列表并要求您重运行
--workspace-uuid <uuid>。 。 。 .
过 --workspace-uuid <uuid> 或者说 --workspace-name <name> 跳过提示.
正在切换工作空间
签到的会话不绑在一个工作区,所以 CARGO_WORKSPACE_UUID 用于单个命令或整个外壳的交换工作空间:
CARGO_WORKSPACE_UUID=<other-workspace-uuid> cargo-ai storage model list
要更改您所用的默认会话, 请再次为工作区签名 :
cargo-ai login --email [email protected] --workspace-uuid <other-workspace-uuid>
API 令牌是不同的: 它被范围化到一个单一的工作空间,服务器从令牌中取出工作空间,而不是从它旁边发送的任何东西中取出. 所以,如果你签了 --token 财务报告和审定财务报表 CARGO_WORKSPACE_UUID 命名不同的工作空间, CLI 拒绝命令, 而不是默默地运行在符号的工作空间上 。 当您自己通过 CARGO_API_TOKEN因为只有你才知道那个标志是用来工作的地方.
环境变量(覆盖)
环境变量优先于保存的证书、对CI有用的证书或临时覆盖证书.
| 变量 | 默认 | 说明 |
|---|---|---|
CARGO_API_TOKEN | —— 说 | 您的货运 API 令牌( Bearer auth) |
CARGO_BASE_URL | https://api.getcargo.io | API 基础 URL |
CARGO_WORKSPACE_UUID | —— 说 | 用于工作空间范围命令的工作空间 UUID( 有些命令也接受) --workspace-uuid(中文(简体) ) |
使用量
命令结构 : cargo-ai <domain> <sub> <action>。 。 。 .
全局安装后, 运行 :
cargo-ai <domain> <sub> <action>
不安装、不使用 npx数字 :
npx @cargo-ai/cli <domain> <sub> <action>
所有命令输出出 JSON 到 stdout .
帮助
cargo-ai --help
cargo-ai orchestration --help
cargo-ai orchestration workflow --help
域和示例命令
| 域名 | 说明 | 示例命令 |
|---|---|---|
| 协调 | 工作流程、播放、运行、批量、工具、模板 | cargo-ai orchestration workflow list, (中文(简体) ), cargo-ai orchestration run list --workflow-uuid <uuid> |
| 工作空间管理 | 工作空间、用户、信使、角色、文件夹 | cargo-ai workspaceManagement workspaces list, (中文(简体) ), cargo-ai workspaceManagement token list |
| 存储 | 数据集、模型、关系、运行、记录 | cargo-ai storage dataset list, (中文(简体) ), cargo-ai storage model list |
| 连接 | 连接器和集成 | cargo-ai connection connector list, (中文(简体) ), cargo-ai connection integration list |
| 账单 | 使用和订阅 | cargo-ai billing subscription get, (中文(简体) ), cargo-ai billing usage get-metrics --payload '{"from":"2025-01-01","to":"2025-01-31"}' |
| 分割 | 部分和更改 | cargo-ai segmentation segment list, (中文(简体) ), cargo-ai segmentation change list --payload '{}' |
| 收入组织 | 分配、能力、成员、领土 | cargo-ai revenue-organization member list, (中文(简体) ), cargo-ai revenue-organization territory list |
| 表达式 | 食谱和表达评价 | cargo-ai expression recipe list, (中文(简体) ), cargo-ai expression eval evaluate --payload '{}' |
| 记录系统 | 记录系统、客户端、日志 | cargo-ai system-of-record sor list, (中文(简体) ), cargo-ai system-of-record log list --payload '{}' |
| 用户管理 | 当前用户( 无工作空间上下文) | cargo-ai user-management user get-current |
| 页:1 | AI 模板、代理、发布、聊天、MCP、文件 | cargo-ai ai template list, (中文(简体) ), cargo-ai ai agent list, (中文(简体) ), cargo-ai ai file list |
| 上下文 | 背景存储器、运行时沙盒和知识图 | cargo-ai context repository get, (中文(简体) ), cargo-ai context runtime browse --path <path>, (中文(简体) ), cargo-ai context graph get |
| 托管 | 货物托管应用软件(Vite SPAs)、工人(env vars、原木)和部署 | cargo-ai hosting app list, (中文(简体) ), cargo-ai hosting worker env list --worker-uuid <uuid>, (中文(简体) ), cargo-ai hosting worker logs list --worker-uuid <uuid>, (中文(简体) ), cargo-ai hosting deployment list --payload '{}' |
| 邮箱管理 | 拥有发送信箱、线索、事件、压制、定价 | cargo-ai mailboxManagement mailbox list, (中文(简体) ), cargo-ai mailboxManagement mailbox get-send-allowance <uuid> |
| 项目 | 声明 IaC:在代码中定义资源,部署,生成类型 | cargo-ai project init <dir>, (中文(简体) ), cargo-ai project types, (中文(简体) ), cargo-ai project plan, (中文(简体) ), cargo-ai project deploy (单位:千美元)cdk 是别名) |
接受复杂有效载荷的指令使用 --payload <json> 选项(例如). cargo-ai orchestration play create --payload '{"name":"My Play",...}') (中文(简体) ). 使用 --help 用于选项的子命令.
orchestration release deploy-draft
部署一份释放草案 现有 工作流程。 两个输入模式共享相同的命令:
# Compile a Workflow SDK module and deploy it
cargo-ai orchestration release deploy-draft --file ./my-workflow.ts
# Preview nodes + form fields without deploying
cargo-ai orchestration release deploy-draft --file ./my-workflow.ts --dry-run
# Pin an explicit version + description
cargo-ai orchestration release deploy-draft --file ./my-workflow.ts --workflow-uuid <uuid> --version 2.0.0 --description "New enrichment path"
# Power-user path: deploy raw wire-format JSON
cargo-ai orchestration release deploy-draft --workflow-uuid <uuid> --nodes '[…]' --form-fields '[…]'
--file <path> 装入 a @cargo-ai/workflow-sdk 模块 export default defineWorkflow(...))和来源 nodes 编号 : formFields 从编译的输出。 与 --file数字 :
--workflow-uuid是可选的 —— 省去时, 命令的最佳效果匹配编译的slug对照现有工作流程template.slug和错误,如果匹配缺失或模糊.--version默认为下个小出错, 而不是最新版本( 或1.0.0(第一组).--nodes编号 :--form-fields被拒绝(它们来自模块).
无 --file, (中文(简体) ), --workflow-uuid, (中文(简体) ), --nodes,以及 --form-fields 全部需要 (raw JSON 路径)。 无论是哪种方式都加以约束: 没有 工作流程创建端点,所以目标工作流程必须已经存在.
其他释放动词(list, (中文(简体) ), get <uuid>, (中文(简体) ), get-deployed, (中文(简体) ), get-draft, (中文(简体) ), update-draft(a) 生活在同一个群体之下——见 cargo-ai orchestration release --help。 。 。 .
代理技能
货物技能 教AI编码代理(Claude Code, Codex, Cursor, Windsurf, GitHub Copilot, Hermes Agent等) 如何使用这个CLI: 货物技能捆绑涵盖铅来源,浓缩,电子邮件验证,铅分,CMM同步,购买-信号监测,管弦,存储,以及项目(GTM作为代码).
让你的经纪人安装一切. 把它粘入 Claude Code, Codex, 或 Cursor 中, 它处理 CLI, 登录, 和它自己的平台的技能:
Install Cargo by following https://api.getcargo.io/INSTALL.md
或者手动安装. 作为插件( Claude Code, Codex, Cursor —— 捆绑技能加批准和会话钩) :
/plugin marketplace add getcargohq/cargo-skills # Claude Code
codex plugin marketplace add getcargohq/cargo-skills
仅作为技能(任何) 技术。sh- 兼容代理商:
npx skills add getcargohq/cargo-skills
选择一个频道——安装两个频道都重复每个技能.
打开 赫尔墨斯探员,从自己的枢纽安装:
hermes skills install skills-sh/getcargohq/cargo-skills/cargo-gtm
发展
# Build
npm run build
# Run with tsx (no build)
npm run dev
# then in another terminal: npx tsx src/index.ts orchestration workflow list
# Type-check and lint
npm run type:check
npm run lint:check
宣告一个选项的值
包含一组已关闭的值的选项将它们列在其占位符中,从未在 其说明:
.option("--format <csv|json>", "Export format")
.option("--statuses <idle,pending,success>", "Filter by statuses")
.option("--is-finished [true|false]", "Only return finished runs")
管子是指"其中一","逗号"指"其中一","逗号相隔"等
这是整个语法。 指挥官将占位符当作显示名,
因此,这在分析时间没有任何变化——但 --help 显示集,并显示
交互调色板将其变成菜单而不是空文本字段. 数值
写在描述中,但两者都看不见.
使用指挥官自己的 .choices() 只有在国家行动倡议应该时 拒绝 任何东西
还有 通常不应该: API 拥有这些列表, 并开始一个值
接受会在这里被拒绝 直到有人注意到.
许可证
许可证信息见项目.