Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
HyperShell v2
Light Logo Dark Logo

Intro

  • Getting Started
  • Installation
  • Security

Reference

  • Command-line Interface
    • cluster
    • server
    • client
    • submit
    • initdb
    • info
    • wait
    • run
    • list
    • update
    • config
    • config get
    • config set
    • config edit
    • config which
  • Library
    • hypershell.submit
    • hypershell.server
    • hypershell.client
    • hypershell.cluster
    • hypershell.data
  • Configuration
  • Logging
  • Database
  • Templates

Tutorial

  • Basic
  • Distributed
  • Hybrid
  • Advanced

Project

  • Blog
    • Release Notes (v2.8.0)
    • Release Notes (v2.7.0)
    • Release Notes (v2.6.6)
    • Release Notes (v2.6.5)
    • Release Notes (v2.6.1)
    • New Logo and Discord Server
    • Release Notes (v2.6.0)
    • Release Notes (v2.5.2)
    • Release Notes (v2.5.0)
    • Release Notes (v2.4.0)
    • Release Notes (v2.3.0)
    • Release Notes (v2.2.0)
  • Roadmap
Back to top
View this page

Command-line Interface¶

Most people will use HyperShell as a command-line utility. Everything shown here is available on Linux and macOS as a manual page. See our Python API for use as a library. See our tutorials (COMING SOON) for use-case specific demonstrations.

The hsx program is short-hand for hs cluster.

Subcommands¶

  • cluster
  • server
  • client
  • submit
  • initdb
  • info
  • wait
  • run
  • list
  • update
  • config
  • config get
  • config set
  • config edit
  • config which
Next
Cluster
Previous
Security
Copyright © 2019-2026 Geoffrey Lentner
Made with Sphinx and @pradyunsg's Furo
On this page
  • Command-line Interface
    • Subcommands