@makehq/cli
v1.1.0
Published
A command-line tool for Make automation platform
Downloads
279
Readme
Make CLI
A command-line interface for interacting with the Make automation platform.
Installation
npm
npm install -g @makehq/cliBinary releases
Pre-built binaries are available for download from the GitHub Releases page:
| Platform | Architecture | File |
| -------- | --------------------- | ------------------------------- |
| Linux | x86_64 | make-cli-linux-amd64.tar.gz |
| Linux | arm64 | make-cli-linux-arm64.tar.gz |
| macOS | x86_64 (Intel) | make-cli-darwin-amd64.tar.gz |
| macOS | arm64 (Apple Silicon) | make-cli-darwin-arm64.tar.gz |
| Windows | x86_64 | make-cli-windows-amd64.tar.gz |
Download and extract the archive for your platform, then place the binary somewhere on your PATH.
Debian/Ubuntu
.deb packages are also available for Linux:
| Architecture | File |
| ------------ | -------------------------- |
| x86_64 | make-cli-linux-amd64.deb |
| arm64 | make-cli-linux-arm64.deb |
sudo dpkg -i make-cli-linux-amd64.debAuthentication
Login (recommended)
Run the interactive login wizard to save your credentials locally:
make-cli loginThis guides you through selecting your zone, opening the Make API keys page in your browser, and validating your key. Credentials are saved to:
- macOS / Linux:
~/.config/make-cli/config.json - Windows:
%APPDATA%\make-cli\config.json
Once logged in, all commands work without any extra flags. To check who you're logged in as:
make-cli whoamiTo remove saved credentials:
make-cli logoutEnvironment variables
export MAKE_API_KEY="your-api-key"
export MAKE_ZONE="eu2.make.com"Per-command flags
make-cli --api-key your-api-key --zone eu2.make.com scenarios list --team-id 1Flags take priority over environment variables, which take priority over saved credentials.
Usage
make-cli [options] <category> <action> [options]Global Options
| Option | Description |
| ----------- | --------------------------------------------------- |
| --api-key | Make API key |
| --zone | Make zone (e.g. eu2.make.com) |
| --output | Output format: json (default), compact, table |
Examples
make-cli scenarios list --team-id=123
make-cli scenarios get --scenario-id=456
make-cli connections list --team-id=123
make-cli data-stores list --team-id=123
make-cli data-store-records list --data-store-id=1
make-cli teams list --organization-id=1
make-cli users me
# Creating a scenario
make-cli scenarios create \
--team-id=123 \
--scheduling='{"type":"on-demand"}' \
--blueprint='{"name":"My Scenario","flow":[],"metadata":{}}'
# Output formatting
make-cli scenarios list --team-id=123 --output=tableCommands
Commands are organized by category:
Scenarios
scenarios— Scenariosexecutions— Scenario Executionsincomplete-executions— Incomplete Executionsfolders— Scenario Foldersfunctions— Custom Functionshooks— Webhooks
Credentials
connections— Connectionskeys— Keyscredential-requests— Credential Requests
Data Stores
data-stores— Data Storesdata-store-records— Data Store Recordsdata-structures— Data Structures
Account Management
teams— Teamsorganizations— Organizationsusers— Usersenums— Enums
Custom App Development
sdk-apps— App Definitionssdk-connections— App Connectionssdk-functions— App Functionssdk-modules— App Modulessdk-rpcs— App Remote Proceduressdk-webhooks— App Webhooks
Run make-cli --help or make-cli <category> --help for the full list of actions and options.
Building
npm run buildTesting
npm test