monolayer Docs
monolayer Docs
Introduction

Getting Started

Install monolayer in your AWS accountAdd a git connectorDeploy your app in monolayer

Platform

OverviewInstallationAuthentication and Configuration
projects:listdeployments:deploy

Other

Feedbackmonolayer SDK Docsmonolayer.devFAQs
CLI

Authentication and Configuration

To interact with your Monolayer control plane, you need to provide a base URL and the appropriate authentication tokens. You can supply these using command-line flags or environment variables.

Base URL

Every command requires a base URL to connect to the control plane.

The CLI resolves the base URL in the following order:

  1. The --base-url flag.
  2. The MONOLAYER_BASE_URL environment variable.

If neither is provided, the command fails and displays:

Missing base URL. Pass --base-url explicitly or set MONOLAYER_BASE_URL.

Authentication tokens

Different commands require specific tokens to keep your environment secure.

CommandRequired flagEnvironment variable
projects:list--auth-tokenMONOLAYER_AUTH_TOKEN
deployments:deploy--auth-tokenMONOLAYER_DEPLOYMENT_TOKEN

Listing projects

When running projects:list, the CLI looks for your authentication token in this order:

  1. The --auth-token flag.
  2. The MONOLAYER_AUTH_TOKEN environment variable.

If the token is missing, the command fails and displays:

Missing auth token. Pass --auth-token explicitly or set MONOLAYER_AUTH_TOKEN.

Deploying projects

When running deployments:deploy, the CLI looks for your deployment token in this order:

  1. The --auth-token flag.
  2. The MONOLAYER_DEPLOYMENT_TOKEN environment variable.

If the token is missing, the command fails.

Important: Your deployment token must begin with deploy_token_. If you provide an invalid token, the command fails and displays:

auth-token must start with "deploy_token_"

Installation

Previous Page

projects:list

Next Page

On this page

Base URLAuthentication tokensListing projectsDeploying projects