Elk

Command Line Interface

Use the Elk CLI tool to automate deployments, manage applications, and interact with our API from your terminal.

API Docs / CLI Tool

Installation

NPM Package

npm install -g @elk/cli
                

Verify Installation

elk --version
                

Core Commands

Deploy Application

elk deploy
                    

Auto-detects project type and triggers a deployment.

List Deployments

elk deployments
                    

View all deployment statuses for your projects.

Add Custom Domain

elk domain add example.com
                    

Configure custom domains with automatic SSL.

View Logs

elk logs --app my-app
                    

Stream application logs in real-time.

Configuration

Initialize Config

elk config init
                

Create and edit elk.yml deployment configuration files.

API Integration

Authenticating with the CLI

elk auth set <API_KEY>
                

Store your API key securely for programmatic access.

Troubleshooting

Common Issues

  • Ensure API_KEY is set and valid
  • Verify network connectivity requirements for CLI
  • Check domain propagation status with elk check dns

Related Resources