Quick Start Guide
Get your Admin workspace up and running in under 5 minutes. Follow these steps to initialize your project and deploy your first instance.
Install the Admin CLI
First, install the Admin command-line interface globally on your system. This tool will help you manage projects, deployments, and configurations.
Node.js v18+ is required.
npm install -g @admin/cliadmin --version in your terminal.
Authenticate & Connect
Log in to your Admin account via the CLI. This links your local development environment to your cloud workspace.
admin loginAfter authentication, select your target workspace or create a new one when prompted.
Initialize Project
Create a new Admin project in your desired directory. The init command will scaffold a starter configuration and guide you through initial setup options.
admin init my-project && cd my-projectDeploy to Production
Once your project is configured, deploy it to the Admin cloud with a single command. Your instance will be live globally within seconds.
admin deploy --prodAfter deployment, you'll receive a unique URL to access your live dashboard. You can also configure custom domains in the settings panel.
Ready to build something amazing?
Once you've completed these steps, explore our documentation to learn about advanced features, API integrations, and customization options.