EnSync CLI Tool

A command-line interface for interacting with the EnSync config management service.

Installation

You can install the EnSync CLI Tool in two ways:

1. From Source

# Clone the repository
git clone https://github.com/EnSync-engine/cli
cd ensync-cli

# Build the binary
make build

# The binary will be available in bin/ensync

2. Using Go Install

If you have Go installed, you can install EnSync CLI directly using the go install command:

# Install the EnSync CLI tool
go install github.com/EnSync-engine/cli@latest

To install a specific version (e.g., v1.0.1):

go install github.com/ensync-cli/cmd/ensync@v1.0.1

The binary will be installed in your Go binary path ($GOPATH/bin or $GOBIN).

Notes:

1. Go Version: go install requires Go 1.17 or later.
2. Path: After installation, ensure that $GOPATH/bin (or $GOBIN) is in your system's PATH so that you can run the ensync command globally.

This method allows you to easily install and update your CLI tool by simply running go install, which is especially useful for developers who already have Go set up on their machines.

Configuration

The CLI can be configured using either a configuration file or environment variables.

Configuration File

Create a config file at ~/.ensync/config.yaml:

base_url: "http://localhost:8080/api/v1/ensync"
sdebug: false

Environment Variables

export ENSYNC_ACCESS_KEY="BjwKUi9EjQtSnR9r9T0MfrrbddIOVCwB"
export ENSYNC_DEBUG=false

Usage

Event Management

List events:

# List events with pagination
ensync-cli --access-key "access-key" event list --page 0 --limit 10 --order DESC --order-by createdAt

# List events with different ordering
ensync-cli --access-key "access-key" event list --order ASC --order-by name

Create event:

ensync-cli --access-key "access-key" event create --name "test-event" --payload '{"key":"value","another":"data"}'

Update event:

# Update event name
ensync-cli --access-key "access-key" event update --id 1 --name "updated/name/name"

# Update event payload
ensync-cli --access-key "access-key" event update --id 1 --payload '{"key":"new-value"}'

# Get event payload by Name
ensync-cli --access-key "access-key" event get --name "updated/name/name"

Access Key Management

List access keys:

# List all access keys
ensync-cli --access-key "access-key" access-key list

Create access key:

# Create access key with permissions
ensync-cli access-key create --access-key "your-access-key" --permissions '{"send": ["event1"], "receive": ["event2"]}'

Manage permissions:

# Get current permissions
ensync-cli --access-key "access-key"  access-key permissions get --key "IeBTeDncBQmDMzJzKblyKfbctvgEKO8L"

# Update permissions
ensync-cli --access-key "access-key"  access-key permissions set --key "IeBTeDncBQmDMzJzKblyKfbctvgEKO8L" --permissions '{"send": ["event12344"], "receive": ["event23445"]}'

General Options

Debug mode:

# Enable debug output
ensync-cli --debug event list

Version information:

# Display version
ensync-cli version

# Get version in JSON format
ensync-cli version --json

Common Flags

• --page: Page number for pagination (default: 0)
• --limit: Number of items per page (default: 10)
• --order: Sort order (ASC/DESC)
• --order-by: Field to sort by (name/createdAt)
• --debug: Enable debug mode
• --config: Specify custom config file location

Error Handling

The CLI provides clear error messages and proper exit codes:

• Exit code 0: Success
• Exit code 1: General error
• Exit code 2: Configuration error
• Exit code 3: API error

Development

Build:

make build

Run tests:

# Run unit tests
make test

# Run integration tests
make test-integration

Lint:

make lint

Release:

make release

License

This project is licensed under the MIT License - see the LICENSE file for details.