Commands

Reference for all Kiosk CLI commands.

kiosk init

Create a KIOSK.md file for your repository:

kiosk init

This analyzes your project and generates a KIOSK.md with installation instructions.

kiosk publish

Publish the current repository to Kiosk:

kiosk publish

This submits your app to the Kiosk registry, making it discoverable at kiosk.app.

kiosk install

Install and run a Kiosk app:

kiosk install author/repo

Aliases: kiosk run

Options:

  • --branch - Install from a specific branch
  • --path - Install from a subdirectory

kiosk run

Run a Kiosk app, installing it if needed:

kiosk run author/repo

This is an alias for kiosk install.

kiosk new

Initialize a new Kiosk app project:

kiosk new

Creates a new project with the necessary structure for a Kiosk app.

kiosk list

List installed apps:

kiosk list

Aliases: kiosk ls

kiosk audit

Audit the current directory for security issues before publishing:

kiosk audit

Checks for common security issues like exposed secrets, sensitive files, or unsafe instructions.

kiosk config

Manage Kiosk configuration:

kiosk config

View and modify your local Kiosk settings.

kiosk tui

Launch the interactive terminal UI:

kiosk tui

Opens a full-screen interface for browsing and managing Kiosk apps.

Global Flags

These flags work with any command:

  • -h, --help - Show help for any command
  • --version - Print the version number

Use kiosk [command] --help for more information about a specific command.