Hypar CLI
What is the Hypar CLI?
The Hypar Command Line Interface (CLI) connects your desktop to the Hypar cloud. It packages utilities for function authoring, code generation, testing, and synchronization with desktop applications. This page describes the commands supported by the Hypar CLI for your reference. This information is also available from within the CLI at any time by running
hypar --help in your terminal.Commands
new | Create a new Hypar function. |
sign-in | Sign in to Hypar. |
sign-out | Sign out of Hypar. |
init | Generate input, output, and function classes from the hypar.json configuration file. |
publish | Publish your function to Hypar. |
pull | Pull changes made to your function via the Hypar web UI down to your local hypar.json. |
edit | Edit your current function's configuration in Hypar's web UI. |
update | Update the current function to the latest version of Hypar, or to a specified version. |
delete | Delete a function from Hypar. |
run | Run the hypar function found in the current directory. Defaults to running the function whenever the function's code or its input change, but can also run across a provided list of input values instead. |
test generate | Generate a unit test based on an existing workflow. |
rename | Rename a function. |
generate-catalog | Generate code for a ContentCatalog. |
generate-types | Generate user element types from the specified url. |
hub | Work with the hypar hub. |
version, --version | Display the version of the currently installed Hypar CLI. |
converter new | Scaffold a new converter for use with the Hypar Revit Plugin |
Typical C# Function Development Flows
Hypar Hub
The Hypar Hub acts as the single point of synchronization between your workflows on Hypar and your local machine. The hub listens for update messages from Hypar, and builds a local cache of data representating the output of the functions in your workflow.
To learn more about the hub, continue below.
Hypar Hub