Skip to main content
Most CLI commands act on a single application in a single environment, so before you tail logs or list incidents, you need to know which apps you have and how to name them. This page covers listing your applications, setting a default organization, and inspecting an app’s resources.

Organizations

Your applications live under an organization, identified by its slug: the short name in your AppSignal URL, appsignal.com/<org-slug>. The CLI works with the organization tied to your signed-in account.

Set a default organization

Most commands fall back to a default organization, so you don’t need to pass --org every time. Running appsignal-cli apps list determines your account’s organization and saves it as the default. To set or change it yourself:
Shell
appsignal-cli apps set-org --org <YOUR_ORG_SLUG>
To see the current default:
Shell
appsignal-cli apps show-org
You can also set the default during sign-in with appsignal-cli auth login --org <YOUR_ORG_SLUG>, or per project with appsignal-cli project init --org <YOUR_ORG_SLUG>. See Authentication for how the global and project-local configs relate.

Applications

To list the applications for your account’s organization:
Shell
appsignal-cli apps list
This also saves your organization as the default for later commands, so you don’t need to pass --org to them.

Find an app by name

To look up a specific app by name, optionally narrowing to one environment:
Shell
appsignal-cli apps find --name "MyApp" --environment production
The name and environment are both case-insensitive. This is the quickest way to confirm the exact app name and environment that other commands expect.

Show details for an app

If you know an app’s ID, you can fetch its details directly:
Shell
appsignal-cli apps info --app-id <APP_ID>

How commands identify an app

Commands that act on a single app accept it in one of two ways:
  • By name: --app "MyApp". Add --environment production only when more than one app shares the name.
  • By ID: --app-id <APP_ID>, the value from the ID column of appsignal-cli apps list (a long hexadecimal string). An ID identifies a specific app and environment on its own, so you don’t pass --environment with it.
Use whichever you have. A name is easier to read and type; the ID is unambiguous and convenient in scripts.

Inspect an app’s resources

The apps resources commands show the configuration and metadata attached to an app:
CommandShows
apps resources allEvery resource below, in one call
apps resources usersUsers with access to the app
apps resources notifiersConfigured notifiers
apps resources namespacesThe app’s namespaces
apps resources dashboardsCustom dashboards
apps resources deploy-markersRecent deploy markers
Each takes the same app selector as other commands, either --app with --environment or --app-id, and uses your default organization unless you pass --org. For example, to see the namespaces for an app:
Shell
appsignal-cli apps resources namespaces --app "MyApp" --environment production
To pull everything at once as JSON, for feeding into another tool:
Shell
appsignal-cli apps resources all --app "MyApp" --environment production --output json

Next steps

Once you know an app’s name and environment, you can start querying it. Inspect its incidents or tail its logs from the terminal.