Skip to content

nuxt-hub/cli

Repository files navigation

NuxtHub CLI

Command Line Interface for the NuxtHub Admin.

Installation

Install the package globally:

npm install -g nuxthub

Or use npx to run the CLI without installing it:

npx nuxthub

Usage

USAGE nuxthub init|deploy|link|unlink|open|manage|login|logout|logs|whoami

COMMANDS

    init    Initialize a fresh NuxtHUb project, alias of nuxi init -t hub.  
  deploy    Deploy your project to NuxtHub.                                   
    link    Link a local directory to a NuxtHub project.                      
  unlink    Unlink a local directory from a NuxtHub project.                  
    open    Open in browser the project's URL linked to the current directory.
  manage    Open in browser the NuxtHub URL for a linked project.             
   login    Authenticate with NuxtHub.                                        
  logout    Logout the current authenticated user.                            
    logs    Display the logs of a deployment.                                 
  whoami    Shows the username of the currently logged in user.               

Use nuxthub <command> --help for more information about a command.

Deployment

To deploy your project to NuxtHub, you can use the nuxthub deploy command. This will build your project and deploy it to your Cloudflare account with zero-configuration.

# Deploy to production or preview based on your current branch
nuxthub deploy

# Deploy to production
nuxthub deploy --production

# Deploy to preview
nuxthub deploy --preview

Open in Browser

To open your project in the browser, you can use the nuxthub open command. This will open the URL of your project in the default browser.

# Open the production or preview deployment based on your current branch
nuxthub open

# Open the production deployment
nuxthub open --production

# Open the latest preview deployment
nuxthub open --preview

License

Apache 2.0