GitHub - harness/harness-cli: Harness CLI for managing Harness resources, from the command line using YAMLs as input [LIMITED GA]

Harness CLI Tool (hc)

A powerful command-line interface tool for interacting with Harness services

Overview

The Harness CLI (hc) provides a unified command-line interface for interacting with various Harness services. It follows a consistent, resource-based command structure:

hc [<global-flags>] <command> <subcommand> [<positional-args>…] [<flags>]

Available Commands

Command	Aliases	Description
`auth`	-	Authentication commands (login, logout, status)
`registry`	`reg`	Manage Harness Artifact Registries
`artifact`	`art`	Manage artifacts in registries
`project`	`proj`	Manage Harness Projects
`organisation`	`org`	Manage Harness Organisations
`api`	-	Raw REST API passthrough for power users

Installation

Quick Install (Recommended)

Install the latest version with a single command:

curl -fsSL https://raw.githubusercontent.com/harness/harness-cli/v2/install | sh

Or with sudo if you need elevated privileges:

curl -fsSL https://raw.githubusercontent.com/harness/harness-cli/v2/install | sudo sh

This script automatically detects your OS and architecture, downloads the appropriate binary, verifies its checksum for security, and installs it to /usr/local/bin.

Custom Installation Directory

You can install to a custom directory by setting the INSTALL_DIR environment variable:

curl -fsSL https://raw.githubusercontent.com/harness/harness-cli/v2/install | INSTALL_DIR=$HOME/.local/bin sh

Manual Binary Installation

Download the latest binary from the releases page:

# Download the latest release for your platform
# Make it executable
chmod +x hc
# Move it to a directory in your PATH
mv hc /usr/local/bin/

Building from Source

# Install go if you haven't

# Clone the repository
git clone https://github.com/harness/harness-cli.git
cd harness-cli

# Build the binary
make build

Configuration

The CLI can be configured using:

Configuration file at $HOME/.harness/auth.json
Environment variables (coming soon)
Command-line flags

Authentication

Before using most commands, you need to authenticate:

# Login with API key
hc auth login

# Check authentication status
hc auth status

# Logout
hc auth logout

You can also provide credentials via:

Configuration file at $HOME/.harness/auth.json
Command-line flags: --token, --account, --org, --project
Environment variables

Command Reference

Authentication (`hc auth`)

Manage authentication with Harness services.

# Login interactively
hc auth login

# Login with API key
hc auth login --api-key <your-api-key>

# Check authentication status
hc auth status

# Logout
hc auth logout

Registry Management (`hc registry` or `hc reg`)

Manage Harness Artifact Registries.

# List all registries
hc registry list
hc reg list  # Using alias

# Get registry details
hc registry get <registry-name>

# Create a registry (coming soon)
hc registry create <registry-name> --package-type DOCKER

# Delete a registry
hc registry delete <registry-name>

# Migrate artifacts from external registries
hc registry migrate --config migrate-config.yaml

Artifact Management (`hc artifact` or `hc art`)

Manage artifacts within registries.

# List all artifacts
hc artifact list
hc art list  # Using alias

# List artifacts in a specific registry
hc artifact list --registry <registry-name>

# Delete an artifact (deletes all versions)
hc artifact delete <artifact-name> --registry <registry-name>

# Delete a specific version of an artifact
hc artifact delete <artifact-name> --registry <registry-name> --version <version>

# Push artifacts
hc artifact push generic <registry-name> <file-path> --name <artifact-name> --version <version>
hc artifact push go <registry-name> <module-path>

# Pull artifacts
hc artifact pull generic <registry-name> <package-path> <destination>

Project Management (`hc project` or `hc proj`) (coming soon)

Manage Harness Projects.

# List all projects
hc project list

# Get project details
hc project get <project-id>

# Create a project (coming soon)
hc project create <project-id>

# Delete a project (coming soon)
hc project delete <project-id>

Organisation Management (`hc organisation` or `hc org`) (coming soon)

Manage Harness Organisations.

# List all organisations
hc organisation list
hc org list  # Using alias

# Get organisation details
hc org get <org-id>

# Create an organisation (coming soon)
hc org create <org-id>

# Delete an organisation (coming soon)
hc org delete <org-id>

API Passthrough (`hc api`) (coming soon)

Make raw REST API calls to Harness (for power users).

# GET request
hc api /har/api/v1/registries

# POST request with data
hc api /har/api/v1/registries --method POST --data '{"identifier":"my-registry"}'

# Custom headers
hc api /har/api/v1/registries --header "Content-Type: application/json"

# PUT/DELETE requests
hc api /har/api/v1/registries/my-reg --method DELETE

Global Flags

The following flags are available for all commands:

--account string          Account ID (overrides saved config)
--api-url string          Base URL for the API (overrides saved config)
--token string            Authentication token (overrides saved config)
--org string              Organisation ID (overrides saved config)
--project string          Project ID (overrides saved config)
--format string           Output format: table (default) or json
--log-file string         Path to store logs

Output Formatting

The CLI supports different output formats using the --format flag:

# Output in JSON format
hc registry list --format=json

# Output in table format (default)
hc registry list --format=table

# Works with all list/get commands
hc artifact list --registry my-reg --format=json

JSON output supports:

Pretty printing with configurable indentation
Smart pagination information
Custom output formatting

Development

Project Structure

harness-cli/
├── api/              # OpenAPI specs for each service
├── cmd/              # CLI commands implementation
│   ├── hc/           # Main CLI entry point
│   ├── auth/         # Authentication commands
│   ├── registry/     # Registry management commands
│   ├── artifact/     # Artifact management commands
│   ├── project/      # Project management commands
│   ├── organisation/ # Organisation management commands
│   └── api/          # API passthrough command
├── config/           # Configuration handling
├── internal/         # Internal packages and generated API clients
├── module/           # Service-specific modules
├── tools/            # Development tools
└── util/             # Utility functions

Adding New Commands (coming soon)

TODO

Building

# Build the binary
make build

# Run tests
make test

# Run linter
make lint

License

MIT License