Appsemble CLI
Manage apps and blocks from the command line.
Installation
npm install @appsemble/cli
Usage
A full list of functionalities can be achieved by running the following command:
appsemble --help
Every subcommand also supports the --help
flag.
Authentication
The Appsemble CLI uses OAuth2 client credentials to authenticate to the Appsemble server.
To login, run the following command and follow the instructions in the output:
appsemble login
To logout, run the following command and select the client credentials to remove:
apsemble logout
The Appsemble CLI also supports authentication using the APPSEMBLE_CLIENT_CREDENTIALS
environment
variable. This is mostly useful for automation.
Organizations
The Appsemble CLI can be used to create and update organizations. For example:
appsemble organization create my-organization --name 'My Organization' --icon icon.png
Apps
The Appsemble CLI can be used to create and update apps. For example, to create an app in the
apps/my-app
directory, run:
appsemble app create apps/my-app
For a more in depth explanation of how to build apps, use our
app building guide.
Blocks
The Appsemble CLI can be used to publish Appsemble blocks. For example, to publish all blocks in the
blocks
directory, run:
appsemble block publish blocks/*
Building blocks uses
Webpack. To use
this, install the additional dependencies
webpack
and
@appsemble/webpack-config
npm install webpack@webpack-4 @appsemble/webpack-config
For a more in-depth explanation of how to build apps, use our
block development guide.
Assets
The Appsemble CLI can be used to upload assets from disk. For example, the following command creates
an asset named example-asset
:
appsemble asset create --app-id 1 path/to/example-asset.png
License
LGPL-3.0-only ©
Appsemble