CLICommands
projects:list
Use the projects:list command to retrieve a list of your projects from the control plane. The results are paginated so you can easily manage large numbers of projects.
Syntax
npx mnlyr projects:list [options]Options
| Option | Description |
|---|---|
--base-url <url> | The base URL of your control plane API. You can also set this using the MONOLAYER_BASE_URL environment variable. |
--auth-token <token> | Your authentication token. You can also set this using the MONOLAYER_AUTH_TOKEN environment variable. |
--cursor <cursor> | The cursor value from a previous response, used to fetch the next set of results. |
--limit <n> | The maximum number of items to return. The default is 50. |
-h, --help | Displays help information for the command. |
Examples
List projects using inline flags
npx mnlyr projects:list \
--base-url https://control-plane-domain \
--auth-token token_xxx \
--limit 20List projects using environment variables
MONOLAYER_BASE_URL="https://control-plane-domain" \
MONOLAYER_AUTH_TOKEN="token_xxx" \
npx mnlyr projects:list --limit 20Fetch the next page of results
npx mnlyr projects:list \
--base-url https://control-plane-domain \
--auth-token token_xxx \
--cursor 1 \
--limit 20Output
The command outputs the results in JSON format directly to your terminal. Note that the --json flag is not required or supported, as JSON is the default format.
{
"items": [
{
"projectId": "proj-1",
"name": "Control Plane",
"repositoryUrl": "https://github.com/monolayer/control-plane"
}
],
"nextCursor": "1"
}Troubleshooting
If the command fails, you might see one of the following messages:
- Missing base URL:
Missing base URL. Pass --base-url explicitly or set MONOLAYER_BASE_URL. - Missing authentication token:
Missing auth token. Pass --auth-token explicitly or set MONOLAYER_AUTH_TOKEN.