Globe CLI Overview

The Globe CLI is a command-line tool that lets you deploy and manage your Globe projects directly from your terminal. Use it to deploy applications, view build logs, manage authentication tokens, create projects from templates, and integrate with CI/CD pipelines—all without leaving your command line.

Prerequisites

To get started, you must have the Dart SDK installed on your machine.

Installation

To install the Globe CLI on your machine, run the following command:

dart pub global activate globe_cli

After installation, confirm it's available by running:

globe --help

Inspecting Version

To check your current version of the Globe CLI:

globe --version

If there's a newer version available, you’ll see a notification when running any CLI command.

Why Use the Globe CLI?

• Deploy quickly: Deploy Flutter and Dart apps in seconds from your terminal
• Terminal-first workflow: Manage deployments without leaving your terminal
• Multi-project support: Link and manage multiple apps or mono-repos
• Secure authentication: Securely manage project-specific tokens
• Real-time monitoring: View build logs directly from your terminal
• CI/CD integration: Easily integrate into shell scripts or CI/CD pipelines

CLI Commands

The Globe CLI provides the following commands, which can be accessed by running globe command subcommand:

• deploy: Deploys your Dart application to Globe.
• login: Logs you into your Globe account.
• logout: Logs you out of your Globe account.
• link: Links a local project directory to a Globe project.
• unlink: Unlinks a local project directory from a Globe project.
• token create: Creates a new authentication token.
• token list: Lists your existing authentication tokens.
• token delete: Deletes an authentication token.
• update: Updates the Globe CLI to the latest version.
• create: Creates a new project from a template.
• build-logs: Displays build logs.

You can get help for any command by adding the --help flag (e.g., globe deploy --help).

Global Flags

All CLI commands have global flags that can be used to modify the behavior of the command, which can be accessed by running globe command --flag.

• --help: Display help information for the command
• --verbose: Display verbose output for the command, such as API calls and debug information
• --token: Use API token for CLI authentication
• --project: Set the Project ID used by this command. Defaults to what was previously linked using globe link
• --org: Set the Organization ID used by this command. Defaults to what was previously linked using globe link

Related Topics

• Creating a New Project - Create a new project from a template
• Deploying a Project - Deploy your application to Globe
• Login and Logout - Authenticate with your Globe account
• Link and Unlink - Connect local projects to Globe projects
• Managing Tokens - Create and manage authentication tokens
• Viewing Build Logs - Monitor build progress from the terminal
• The globe.yaml File - Define project configuration as code