Installing Apps

Learn how to install apps from Kiosk into your projects.

How Installation Works

When you install a Kiosk app:

The CLI fetches the app's repository information
Claude Code clones the repository
Claude Code reads the KIOSK.md file
Claude Code follows the installation instructions

Install Command

The basic install command is:

kiosk install author/repo

For example:

kiosk install acme/ui-components

What Happens During Installation

Claude Code will:

Clone or download the specified repository
Look for KIOSK.md, Kiosk.md, or kiosk.md
Read and follow the installation instructions
Copy files, install dependencies, and configure as needed
Report any issues or ask for clarification

Installing from a Branch

To install from a specific branch:

kiosk install author/repo --branch feature-branch

Installing from a Subdirectory

Some repositories contain multiple apps. To install from a subdirectory:

kiosk install author/repo --path packages/my-app

Troubleshooting

Installation fails

If installation fails:

Check that the repository exists and is accessible
Verify the KIOSK.md file exists
Review the error message from Claude Code
Try cloning the repo manually to test access

Missing dependencies

If you're missing dependencies after installation:

Check the KIOSK.md for any manual steps
Run npm install or your package manager's install command
Look for configuration files that need updating

Wrong files copied

If files were copied to the wrong location:

The KIOSK.md instructions may be unclear
Report the issue to the app publisher
Manually move files to the correct location

Tips

Read before installing - Preview the KIOSK.md on the app's page
Use a clean branch - Install on a new Git branch for easy rollback
Check the source - Review the repository before installing