MagicPath CLI

( Instantly bring your MagicPath AI projects to your local development environment. Edit, remix, and create in your own vibe.

Quick Start

npx magicpath-ai@latest clone -k <your-access-key>

Installation

Using npx (Recommended)

No installation required! Just run:

npx magicpath-ai@latest clone -k <access-key>

Global Installation

npm install -g magicpath-ai
magicpath-ai clone -k <access-key>

Local Installation

npm install magicpath-ai
npx magicpath-ai clone -k <access-key>

Usage

Clone Command

Download and set up a MagicPath project locally:

npx magicpath-ai@latest clone -k <access-key> [options]

Options:

• -k, --key <accessKey> (required): = One-time magic access key to unlock and download your project
• -d, --debug: Get verbose debug logs in the CLI

Example:

npx magicpath-ai@latest clone -k mp_1234567890abcdef

The CLI will:

1. =� Download your project using the access key
2. =� Prompt you to name your project (default: magicpath-project)
3. =� Unpack the project to a local directory
4. <� Your project is ready to go!

What You Get

When you clone a MagicPath project, you'll get a complete local copy with:

• All project files and assets
• Configuration files
• Dependencies and setup instructions
• Ready-to-run codebase

Requirements

• Node.js >=16.0.0
• npm or yarn

How It Works

1. Access Key: Each MagicPath project comes with a unique, one-time access key
2. Secure Download: The CLI securely downloads your project from MagicPath servers
3. Local Setup: Projects are extracted and set up in your chosen directory
4. Ready to Code: Start editing, remixing, and building immediately

Troubleshooting

Invalid Access Key

• Ensure your access key is correct and hasn't been used before
• Access keys are single-use for security

Download Issues

• Check your internet connection
• Verify the access key hasn't expired
• Use --debug flag for detailed error information

Permission Errors

• Ensure you have write permissions in the current directory
• Try running from a different directory

Support

• Issues: GitHub Issues
• Email: [email protected]
• Website: magicpath.ai

License

MIT � Jack Beoris

Made with ( by the MagicPath team