Essal CLI - Essal Developer Docs

The Essal CLI is a command-line tool for interacting with the Essal API from your terminal. It supports all six apps and is designed for developer automation and scripting workflows.

Installation

npm install -g @essal/cli
# or
brew install essal/tap/essal

Authentication

essal login
# Opens browser for OAuth flow and stores credentials locally

# Or authenticate with an API key directly
essal config set api-key esk_live_xxxxxxxxxxxxxxxxxxxx

Command Structure

essal <app> <resource> <action> [options]

Examples

# List documents
essal office documents list --limit 10

# Create a Sales contact
essal sales contacts create --display-name "Jane Smith" --email "jane@acmecorp.com"

# Move a deal to a new stage
essal sales deals update deal_01HXYZAAA --stage-id stg_01HXYZ3333

# Create a Project task
essal project tasks create --project proj_01HXYZ9876 --title "Design review" --priority high

# View Guard audit log (last 20 entries)
essal guard audit-logs list --limit 20

# Trigger an immediate directory sync
essal access directories sync dir_01HXYZDIR1

Output Formats

# Default: human-readable table
essal office documents list

# JSON output (for scripting)
essal office documents list --output json

# Quiet mode (IDs only)
essal office documents list --output ids

Scripting with the CLI

#!/bin/bash
# Example: move all qualifying deals to the next stage
essal sales deals list --stage-id stg_01HXYZ2222 --output json | \
  jq -r '.data[].id' | \
  xargs -I {} essal sales deals update {} --stage-id stg_01HXYZ3333