CLI Overview

The tinykit-cli CLI lets you scaffold new TinyKit projects with a single command. No installation required - just run it via npx.

Quick Start

npx tinykit-cli my-app

This will:

1. Check your system prerequisites
2. Authenticate you via browser (if needed)
3. Let you select a TinyKit product
4. Download and extract the project to my-app/
5. Display next steps for getting started

Features

• Zero Installation: Run directly via npx without installing globally
• OAuth Authentication: Secure browser-based login with token stored in OS keychain
• System Prerequisites Check: Validates Git, Node.js, and Bun availability
• Interactive Product Selection: Choose from available TinyKit products
• Progress Tracking: Real-time download progress with visual feedback
• Cross-Platform: Works on macOS, Windows, and Linux

System Requirements

Note: While Bun is recommended for the best TinyKit experience, npm, yarn, or pnpm will also work for package management.

Basic Usage

Create a New Project

# Interactive mode (prompts for project name and product)
npx tinykit-cli

# Specify project name
npx tinykit-cli my-saas-app

# Skip prompts with flags
npx tinykit-cli my-app --product tinykit-pro

Authentication

# Login to TinyKit
npx tinykit-cli login

# Check current user
npx tinykit-cli whoami

# Logout
npx tinykit-cli logout

Updates

# Check for CLI updates
npx tinykit-cli update --check

# Update to latest version
npx tinykit-cli update

What's Next?

• Command Reference - Detailed documentation for all CLI commands
• Authentication - How the OAuth flow works and token storage
• Setup Wizard Guide - What to do after project creation