flourish assign-version-number

flourish assign-version-number [template id] version

Assign a version number to a template that does not have one yet. If template-id is omitted, uses the id of the template in the current directory.

This command was added in version 3.9.0 of the Flourish SDK.

flourish build

flourish build [build rules...]

Build the template in the current directory.

Build rules are specified in template.yml. By default flourish build runs all build rules. If rules are named on the command line, just those rules are run.

This is mainly useful for testing build rules. In the ordinary course of development, your template will be built when “flourish run” is called and rebuilt when source files change, according to the build rules in template.yml.

flourish delete

flourish delete [--force] template_id version

Deletes the specified template from the server, assuming it has previously been published using flourish publish.

If you do not specify a version, Flourish will treat it as a legacy unversioned template. If you have ever published the template with a version number, you must specify which version to delete. Use flourish list template_id to see which versions are on the system.

If the template is in use by users other than you, it will not be possible to delete it. If you have used it, you can pass the –force flag to delete the template and associated visualisations.

flourish help

flourish help [command]

Show help on a particular command.

flourish history

flourish history [template id]

List the version numbers of a published template.

These are the versions that are available to be used in the Live API. This includes every non-prerelease version that was published, and any prereleases that have not been superseded by a release.

With the --full option, prints all the template metadata in JSON format.

This command requires you to be logged in to an account.

flourish list

flourish list [template id]

List the ids and versions of your published templates.

If you specify a template id, it will list the versions of that template that are available on the server.

With the --full option, prints all the template metadata in JSON format.

This command requires you to be logged in to an account.

flourish login

flourish login [email_address]

Log in to Flourish. You will be prompted for a password.

If you do not have a Flourish account, you can register using “flourish register”.

When you have logged in successfully, your access token will be recorded in the file .flourish_sdk in your $HOME or $USERPROFILE directory. Subsequent flourish commands will use this token to authenticate with the server.

flourish logout

flourish logout

Deletes the .flourish_sdk file from your $HOME or $USERPROFILE directory. You will not be able to communicate with the server until you flourish login

flourish new

flourish new directory_name

Creates a new skeleton Flourish template in the named directory, and runs npm update to populate its node_modules directory.

The skeleton template has an example build configuration that uses Less to compile stylesheets and Rollup to bundle JavaScript code. You can run it in the SDK using flourish run.

flourish publish

flourish publish [directory_name]

Build and publish the template in the named directory, or in the current directory if no directory is specified.

Before you publish a template, check that it has an “id” defined in template.yml that you have not previously used. If you reuse an id from another template then that template will be overwritten with this one.

You must be logged in to use this command. See flourish login.

See the Template Versioning reference for a detailed explanation of the options below.

Options:

--patch
Increment the patch number before publishing. Useful for making a quick patch.
--prerelease
Increment the prerelease tag before publishing. Useful for testing a template on the server.
--release
Remove the prerelease tag before publishing.

flourish register

flourish register

Prompt for information and register an account with Flourish. You will automatically be logged in to your new account.

This account can be used on [https://flourish.studio/] as well as in the SDK.

flourish run

flourish run [-o|--open] [--no-build] [--port=1685] [directory_name]

Builds the template and runs the SDK server. If directory_name is omitted it uses the current directory.

While it’s running it watches the template directory for changes:

  • if you edit any static template files (index.html, template.yml, data/, static/) the SDK will refresh the page in the browser;
  • if you edit a file that is the source for a build rule defined in template.yml,the SDK will run that build rule and then refresh the page.

Options:

--open or -o
Try to open the SDK in your web browser once the server is running. At present this only works on macOS.
--port=1685
Listen on a particular port; defaults to 1685.
--listen=0.0.0.0
Listen on a particular interface; defaults to localhost.
--no-build
Skip the build process

flourish upgrade

flourish upgrade [template_directory]

Upgrade the template in template_directory, or in the current directory if no template_directory is specified, to be compatible with the current version of Flourish.

This is only needed when incompatible changes have been made to Flourish.

flourish whoami

flourish [--full] whoami

With no options, prints the username of the currently logged-in account.

With the --full option, prints all the account metadata in JSON format.