Hallway
Hallway|Docs

CLI Reference

The Hallway CLI (hw) provides powerful tools for creating, developing, and managing your Hallway applications.

Installation

deno install -grAf jsr:@hallway/hw

This installs the hw command globally on your system.

Commands

hw setup

Initial setup and configuration of the Hallway CLI. This command will prompt you for your API key.

hw setup

hw create

Create a new Hallway app from a template or initialize a new app in the current directory.

hw create [app-name]

Options:

  • --name <name> - App name
  • --description <desc> - App description
  • --icon <icon> - App icon (emoji or URL)

hw push

Push your app to Hallway. Creates or updates an app from your local directory.

hw push [path]

Options:

  • -y, --yes - Skip confirmation prompts
  • -c, --config <profile> - Use specific profile
  • -k, --key <key> - API key to use

hw pull

Pull an app from Hallway to your local directory.

hw pull <app-id> [destination]

Options:

  • --env - Also pull environment variables

hw list

List all your Hallway apps in a formatted table.

hw list

Displays app icons, names, URLs, and creation dates in a table format.

hw watch

Watch for file changes and automatically push updates to Hallway.

hw watch [path]

Automatically syncs your local changes to Hallway as you develop.

hw browse

Open an app in your browser.

hw browse <app-id>

hw fork

Fork an existing app to create your own copy.

hw fork <app-id> [destination]

hw rename

Rename an existing app.

hw rename <app-id> <new-name>

hw publish

Publish your app to the Hallway Store.

hw publish <app-id>

Makes your app available for others to discover and install from the Hallway Store.

hw reset

Reset an app's data and state.

hw reset <app-id>

Options:

  • --data - Reset only data
  • --code - Reset only code

hw compile

Compile your app for production deployment.

hw compile [path]

hw profile

Manage CLI profiles for different Hallway environments (e.g., beta, production).

hw profile list                    # List all profiles
hw profile add <name>               # Add a new profile
hw profile set-default <name>       # Set default profile
hw profile remove <name>            # Remove a profile

Profiles allow you to easily switch between different Hallway environments or accounts.

Profile Commands:

  • list - Show all configured profiles
  • add <name> - Add or update a profile with API URL and key
  • set-default <name> - Set the default profile to use
  • remove <name> - Remove a profile

Global Options

These options can be used with any command:

  • -c, --config <profile> - Use a specific profile for this command
  • -k, --key <key> - Override API key for this command
  • --help, -h - Show help for a command
  • --version, -v - Show CLI version

Common Examples

# Initial setup
hw setup

# Create a new app
hw create my-app

# Push to Hallway
hw push

# List your apps
hw list

# Use a different profile
hw list -c production

# Watch for changes and auto-push
hw watch

# Fork an existing app
hw fork 9a62c279-e3fa-4e9d-86c7-4616f68d7e3e my-fork