Back to Kiosk

Publishing Your App

Learn how to publish your app to Kiosk and share it with the community.

Prerequisites

Before publishing, ensure you have:

  • A Git repository (GitHub, GitLab, etc.)
  • A KIOSK.md file in your repository
  • The Kiosk CLI installed

Publishing Steps

1. Create Your KIOSK.md

If you don't have a KIOSK.md file yet, use the init command:

kiosk init

This will analyze your project and help create a KIOSK.md file with installation instructions.

2. Test Locally

Before publishing, test that your installation instructions work:

  1. Clone your repo to a fresh location
  2. Follow the KIOSK.md instructions manually
  3. Verify everything works as expected

3. Publish to Kiosk

Run the publish command:

kiosk publish

The CLI will:

  1. Detect your repository information from Git
  2. Read your project metadata
  3. Submit your app to the Kiosk registry
  4. Return a URL where your app is listed

App Metadata

When publishing, Kiosk collects:

  • Name — Display name for your app (from package.json or prompt)
  • Description — Short description (from package.json or prompt)
  • Repository — URL to your repository (from Git remote)
  • Branch — Branch to use, defaults to main (from Git)

Updating Your App

To update an existing app, simply run kiosk publish again. The CLI will detect the existing app and update its metadata.

Unpublishing

To remove your app from Kiosk:

kiosk unpublish

Best Practices

  • Write a clear description - Help users understand what your app does
  • Keep KIOSK.md updated - Update instructions when your app changes