Hyperclast CLI

Pipe command output directly to pages. Capture build logs, save script output, manage your workspace from the terminal.

Unix-friendly Scriptable Fast Secure
Download for Apple Silicon or Intel Mac
curl -L https://hyperclast.com/downloads/cli/darwin-arm64/ -o hyperclast && chmod +x hyperclast

After downloading: chmod +x hyperclast to make it executable. If macOS shows "cannot be opened", also run: xattr -d com.apple.quarantine ./hyperclast

Download for Linux
curl -L https://hyperclast.com/downloads/cli/linux-amd64/ -o hyperclast && chmod +x hyperclast

After downloading: chmod +x hyperclast to make it executable.

Download for Windows
Invoke-WebRequest -Uri "https://hyperclast.com/downloads/cli/windows-amd64/" -OutFile "hyperclast.exe"
1

Clone the repository

git clone https://github.com/hyperclast/workspace.git
2

Build the CLI

cd workspace/cli && go build -o hyperclast .
3

Move to your PATH (optional)

sudo mv hyperclast /usr/local/bin/
View source on GitHub

Quick Start

1

Authenticate

Log in with your API token from Settings.

hyperclast auth login
2

List your projects

See which projects you have access to.

hyperclast project list
3

Set a default project

So you don't have to specify it every time.

hyperclast project use <project-id>
4

Pipe content to a page

Capture any command output as a new page.

make build 2>&1 | hyperclast page new --title "Build Log"

Command Reference

Authentication

hyperclast auth login

Authenticate with your API token. Prompts for token with secure input.

hyperclast auth logout

Remove stored credentials from your config file.

hyperclast auth status

Check current authentication status and display logged-in user.

Organizations

hyperclast org list

List all organizations you belong to.

hyperclast org current

Show the current default organization.

hyperclast org use <id>

Set the default organization for future commands.

Projects

hyperclast project new <name> [--org <id>] [--description <string>] [--use]

Create a new project. Uses default org if --org not specified. Pass --use to set as default project.

hyperclast project list [--org <id>]

List projects. Optionally filter by organization.

hyperclast project current

Show the current default project.

hyperclast project use <id>

Set the default project for future commands.

Pages

hyperclast page new [--project <id>] [--title <string>] [--file <path>] [--filetype <type>] [--meta] [--source <string>]

Create a new page from stdin or file. Title defaults to timestamp. CSV/TSV and HTTP logs are auto-detected (use --filetype to override). Pass --meta to append capture metadata.

hyperclast page append <id> [--file <path>] [--meta] [--source <string>]

Append content to the end of an existing page.

hyperclast page prepend <id> [--file <path>] [--meta] [--source <string>]

Prepend content to the beginning of an existing page.

hyperclast page overwrite <id> [--file <path>] [--meta] [--source <string>]

Replace all content of an existing page.

hyperclast page delete <id> [--force]

Delete a page permanently. Prompts for confirmation unless --force is used.

hyperclast page list [--project <id>]

List pages. Optionally filter by project.

hyperclast page get <id>

Output page content to stdout. Useful for piping or redirection.

Smart Format Detection

CSV / TSV

Files with consistent comma or tab delimiters are auto-detected and displayed as sortable, filterable tables.

HTTP Access Logs

Apache/Nginx combined log format is auto-detected and displayed with IP highlighting and filtering.

--filetype <type>

Override auto-detection. Supported types: txt, md, csv, log.

Utility

hyperclast version [--verbose]

Print version information. Pass --verbose for build time, git commit, Go version, and OS/arch.

hyperclast completion [bash|zsh|fish|powershell]

Generate shell completion scripts. See hyperclast completion --help for setup instructions.

Global Flags

These flags work with all commands:

Flag Default Description
--config <path> ~/.config/hyperclast/config.yaml Custom config file location
--api-url <url> https://hyperclast.com/api API URL (for self-hosted instances)
--output <format> text Output format: text or json
--quiet false Suppress info messages, only output data
--verbose false Show debug output

Configuration

The CLI stores configuration in ~/.config/hyperclast/config.yaml. You can also set HYPERCLAST_CONFIG environment variable to use a different path. 

api_url: https://hyperclast.com/api
token: your-api-token-here
defaults:
  org_id: org_abc123
  project_id: proj_xyz789

Environment Variables

Variable Description
HYPERCLAST_TOKEN API token. Overrides the token in config file. Recommended for CI/CD.
HYPERCLAST_CONFIG Path to config file. Overrides the default ~/.config/hyperclast/config.yaml.

Examples

CI/CD Integration

# Authenticate via environment variable (no config file needed)
export HYPERCLAST_TOKEN="your-api-token"

# Save build logs from your CI pipeline
npm run build 2>&1 | hyperclast page new \
  --project proj_builds \
  --title "Build #${CI_BUILD_NUMBER}"

# Capture page ID for downstream steps
PAGE_ID=$(echo "content" | hyperclast page new --title "Log" --quiet)
echo "Created page: $PAGE_ID"

Capture Any Command Output

# Git history
git log --oneline -20 | hyperclast page new --title "Recent Commits"

# Docker status
docker ps -a | hyperclast page new --title "Container Status"

# Server health
(uptime; free -h; df -h) | hyperclast page new --title "Server Status"

With Metadata

# Append source info and timestamp to content
make build 2>&1 | hyperclast page new \
  --title "Build Log" \
  --meta \
  --source "make build"