Farin Farin
Developer tools

Use the tenant CLI

Install the @farinapp/tenant-cli NPM package to query and mutate your workspace data directly from your terminal or CI/CD pipelines.

3 min read Updated Mar 18, 2026 Developers and operators building custom integrations

The @farinapp/tenant-cli package gives you command-line access to your Farin workspace.

Use it to test queries, automate workflows, or explore your data without writing a full custom script.

Quick facts

Start here

  • You need a Farin API key before you can authenticate the CLI.
  • The CLI supports discovery (describe), reads (query), and writes (mutate).
  • It enforces the same domain permissions as your API key.

Step 1: Install the CLI and authenticate

  • Run npx @farinapp/tenant-cli login wz_... using your active API key.
  • The key is saved locally in ~/.config/wazi/config.json.
  • Alternatively, you can set the WAZI_API_KEY environment variable instead of using the login command.

Step 2: Discover available data

  • Run npx @farinapp/tenant-cli describe to see a list of available domains.
  • Run npx @farinapp/tenant-cli describe <domain> to see the resources inside a specific domain, like describe order.

Step 3: Query and mutate data

  • To fetch data: npx @farinapp/tenant-cli query <domain> <resource> --limit 5.
  • To create a record: npx @farinapp/tenant-cli mutate <domain> <resource> create --data '{"key": "value"}'.
  • Run npx @farinapp/tenant-cli --help for full command options and syntax.

Share instructions with your agent

If you are using the CLI through a coding agent (like Claude Code or Gemini CLI), you can share our CLI Skill instructions to help it use the commands correctly.

  • Open Farin CLI Skill to view or copy the instructions.
  • Copy the content and paste it into your agent's system prompt or project memory.