Prox CLI

Company onboarding and complete control-plane access · Last updated August 2026

Install or update

The CLI is a small Node.js 20+ executable hosted by Prox on Vercel. The installer downloads it, verifies its SHA-256 checksum, and places it in ~/.local/bin/prox. Running the same command updates it to the version from the latest promoted production commit.

curl -fsSL https://useprox.com/install.sh | sh

prox --update

Installations older than 0.6.0 must run the install command once. After that, employees can run prox --update whenever a new CLI version is promoted. Downloading the CLI does not grant access to a workspace; every data operation still requires Prox admin authorization.

Human authentication

Operators sign in through WorkOS in their browser. Credentials are stored with user-only permissions, refreshed automatically, and scoped to the admin CLI endpoint.

prox login

Claude Tag authentication

Configure Claude Tag's Agent Proxy to allow HTTPS requests to api.useprox.com and inject a WorkOS machine-to-machine bearer token with the Prox admin scope. Then run commands with --agent-proxy. The CLI deliberately sends no local credential in this mode; the proxy adds authorization outside Claude's sandbox, so Claude never sees the client secret or access token.

prox products upload ./manuals --company acme --product RTU-48 --agent-proxy --wait

Create and onboard

prox company create acme --name "Acme Industrial"

Create the company workspace directly with ordinary command-line flags.

prox groups add --company acme --name "Rooftop Units"

Create a top-level product family. Groups own their own files and Product children.

prox products add --company acme --group rooftop-units --name "RTU 48" --identifier RTU-48

Create a Product model inside the Group and return its stable space ID and URL.

prox units add --company acme --product RTU-48 --name "RTU 48 · Building A" --identifier SN-0042

Create a protected serialized Unit under the Product. The Unit has its own files and knowledge tree.

prox products upload ./manuals --company acme --product RTU-48 --wait

Recursively find supported documents in a folder, upload them with byte progress, and wait for ingestion.

prox dealers create "Northwest Dealer" --company acme --member-email rep@example.com

Create a channel account and invite its first user.

prox dealers grant DEALER_ID rooftop-units RTU-48 --company acme

Grant Groups, Products, Units, or General spaces while preserving every existing space and tool grant.

prox public link RTU-48 --company acme

Enable the public agent for the product and return its exact public URL.

Build tenant tools directly

A coding agent can research a demo and author backend.py, frontend.html, schema.json, and test-input.json in one local directory. The CLI sends those sources straight to the same isolated tool runtime as the website; it never asks the company's main chat agent to build the tool. There is no upload manifest and no inline JSON on the command line.

prox tools test ./quote_calculator --company acme

Validate the schema and sandboxed frontend, then execute backend.py with the representative input without saving or notifying anyone.

prox tools publish ./quote_calculator --company acme --visibility internal --yes

Repeat the verification gate, publish for company members, and return the tool ID, runtime session ID, visibility, and Tools URL.

prox tools run quote_calculator --company acme --arg quantity=12 --arg expedited=true

Run the published backend directly with native repeatable flags and print its output plus the runtime session ID.

prox tools guide

Print the complete project layout, Python contract, frontend sandbox rules, schema requirements, and visibility behavior from the installed CLI.

Inspect and ask

prox units inspect --company acme --unit SN-0042

Return one Unit's ingest state, full knowledge tree, source downloads, and attachments. IDs, slugs, identifiers, and exact names work.

prox ask How do I service RTU-48? --company acme

Run the internal agent and return its answer, session ID, session URL, artifacts, and files.

Built-in reference

Run prox --help for the command map and prox help superpower for the complete Group → Product → Unit model, progress behavior, authentication modes, and exact examples. Human-readable output is the default; onboarding and upload never require JSON. prox tools guide documents the direct tenant-tool gateway. prox tools --admin lists every server capability with its description; prox tools TOOL --admin prints that tool's complete input schema. Finally, prox call TOOL JSON --admin exposes new server capabilities immediately, even before a friendly native command is added.