Skip to main content

Ever Works CLI

The Ever Works CLI (ever-works-cli) is a command-line interface that allows you to interact with the Ever Works Platform directly from your terminal. It provides convenient commands for managing works, authentication, and content generation workflows.

Installation​

You can install the CLI globally using npm:

npm install -g ever-works-cli

Or run it directly via npx:

npx ever-works-cli <command>

Basic Usage​

The CLI uses the ever-works command. To see the available commands:

ever-works --help

Output:

Usage: ever-works [options] [command]

Options:
  -v, --version   output the current version
  -h, --help      display help for command

Commands:
  work       Work management commands
  auth            Authentication commands
  help [command]  display help for command

Configuration​

By default, the CLI tries to connect to the platform API at http://localhost:3100. You can override this during login:

ever-works auth login --api-url https://api.your-platform.com

Prerequisites​

  • Node.js v18 or higher
  • A running instance of the Ever Works Platform API (locally or remote)