Springboard Tools¶

Springboard provides various command line tools for cloning, indexing, mapping, syncing and bootstrapping.

$ springboard --help

Springboard command line tools.

usage: springboard [-h]
                   {bootstrap,clone,create-index,create-mapping,sync-data,startapp,import,update-messages}
                   ...

Sub-commands:

bootstrap

Tools for bootstrapping new content repositories locally.

usage: springboard bootstrap [-h] [-c CONFIG] [-d] [-v] [-r REPO_DIR]

Options:

-c=springboard.yaml, --config=springboard.yaml
	The configuration file to load
-d=False, --clobber=False
	Clobber any existing data if it exists.
-v=False, --verbose=False
	Verbose output.
-r=repos, --repo-dir=repos
	Local directory to put repositories in.

clone

Tools for cloning repositories locally.

usage: springboard clone [-h] [-c CONFIG] [-d] [-v] [-r REPO_DIR]
                         [-rn REPO_NAME]

Options:

-c=springboard.yaml, --config=springboard.yaml
	The configuration file to load
-d=False, --clobber=False
	Clobber any existing data if it exists.
-v=False, --verbose=False
	Verbose output.
-r=repos, --repo-dir=repos
	Local directory to put repositories in.
-rn, --repo-name
	The name of the repository to clone.

create-index

Create a search index for models stored in elastic-git

usage: springboard create-index [-h] [-c CONFIG] [-d] [-v] [-r REPO_DIR]
                                repo_name

Positional arguments:

repo_name

The repository name

Options:

-c=springboard.yaml, --config=springboard.yaml
	The configuration file to load
-d=False, --clobber=False
	Clobber any existing data if it exists.
-v=False, --verbose=False
	Verbose output.
-r=repos, --repo-dir=repos
	Local directory to put repositories in.

create-mapping

Upload a mapping for models stored in elastic-git

usage: springboard create-mapping [-h] [-c CONFIG] [-d] [-v] [-r REPO_DIR]
                                  repo_name

Positional arguments:

repo_name

The repository name

Options:

-c=springboard.yaml, --config=springboard.yaml
	The configuration file to load
-d=False, --clobber=False
	Clobber any existing data if it exists.
-v=False, --verbose=False
	Verbose output.
-r=repos, --repo-dir=repos
	Local directory to put repositories in.

sync-data

Sync data from a local repo with elastic-git

usage: springboard sync-data [-h] [-c CONFIG] [-d] [-v] [-r REPO_DIR]
                             repo_name

Positional arguments:

repo_name

The repository name

Options:

-c=springboard.yaml, --config=springboard.yaml
	The configuration file to load
-d=False, --clobber=False
	Clobber any existing data if it exists.
-v=False, --verbose=False
	Verbose output.
-r=repos, --repo-dir=repos
	Local directory to put repositories in.

startapp

Create new applicaton scaffolding

usage: springboard startapp [-h] [--security-key THUMBOR_SECURITY_KEY]
                            [-a AUTHOR] [-e AUTHOR_EMAIL] [--url URL]
                            [-l LICENSE] [-p]
                            app_name

Positional arguments:

app_name

The name of the application to start.

Options:

--security-key=
	The thumbor security key to use.
-a=, --author=	The author’s name.
-e=, --author-email=
	The author’s email address.
--url=	The project’s URL.
-l=BSD, --license=BSD
	The application’s licence.
-p=True, --prompt=True
	Undocumented

import

Clone and import a content repository.

usage: springboard import [-h] [-c CONFIG] [-d] [-v] [-r REPO_DIR]
                          [-i INI_CONFIG] [-s INI_SECTION] [-u] [-n REPO_NAME]
                          [-H REPO_HOST]
                          repo_url

Positional arguments:

repo_url

The URL of the Git content repository to clone.

Options:

-c=springboard.yaml, --config=springboard.yaml
	The configuration file to load
-d=False, --clobber=False
	Clobber any existing data if it exists.
-v=False, --verbose=False
	Verbose output.
-r=repos, --repo-dir=repos
	Local directory to put repositories in.
-i=development.ini, --ini=development.ini
	The paste ini file to update.
-s=app:main, --ini-section=app:main
	The paste ini section to update
-u=True, --update-config=True
	Add the repository to the config files?
-n, --name	Give the repository a custom name.
-H, --host	The unicore.distribute service that will host the repo.

update-messages

Update or create .po and .mo message files

usage: springboard update-messages [-h] [-i INI_CONFIG] [-s INI_SECTION]
                                   [-l [LOCALES [LOCALES ...]]]

Options:

-i=development.ini, --ini=development.ini
	The paste ini file to get the locales from.
-s=app:main, --ini-section=app:main
	The paste ini section to get the locales from.
-l, --locale	The locales to update or create.