Apps

Support for the core Tapis applications life cycle is provided by the apps command set. Extensions to the core API commands, such as apps init and apps deploy are also included.

General

apps list

List the Apps catalog

tapis apps list
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

-l INT, --limit INT

Limit to N records (default: 100)

-o INT, --offset INT

Skip first N records

Replaces legacy CLI command “apps-list”

apps show

Show details for an App

tapis apps show APP_ID
APP_ID

App identifier

Replaces legacy CLI command “apps-list”

apps history

Show history for an App

tapis apps history
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    APP_ID
--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

-l INT, --limit INT

Limit to N records (default: 100)

-o INT, --offset INT

Skip first N records

APP_ID

App identifier

Replaces legacy CLI command “apps-history”

apps create

Create a new App

tapis apps create [-W DIRECTORY] [-F FILEPATH] [--ini FILEPATH]
-W DIRECTORY

Working directory

-F FILEPATH, --file FILEPATH

JSON payload file

--ini FILEPATH

.ini file (project.ini)

Replaces legacy CLI command “apps-addupdate”

apps update

Update an existing App

tapis apps update [-W DIRECTORY] [-F FILEPATH] [--ini FILEPATH] APP_ID
-W DIRECTORY

Working directory

-F FILEPATH, --file FILEPATH

JSON payload file

--ini FILEPATH

.ini file (project.ini)

APP_ID

App identifier

Replaces legacy CLI command “apps-addupdate”

apps clone

Clone an App

tapis apps clone
    [-e EXECUTION_SYSTEM]
    [-s STORAGE_SYSTEM]
    [-p STORAGE_PATH]
    [-n APP_NAME]
    [-x APP_VERSION]
    APP_ID
-e <EXECUTION_SYSTEM>, --execution-system <EXECUTION_SYSTEM>

Execution system where the cloned app will run. Defaults to the current app’s execution system.

-s <STORAGE_SYSTEM>, --deployment-system <STORAGE_SYSTEM>

Storage system where the cloned app assets will be stored. Defaults to the current user’s default storage system.

-p <STORAGE_PATH>, --deployment-path <STORAGE_PATH>

Path on storage system where the cloned app assets will be stored. Only applies when cloning a public app.

-n <APP_NAME>, --app-name <APP_NAME>

Optional new name of the cloned app. Defaults to the current App name and the authenticated user’s username appended with a dash.

-x <APP_VERSION>, --app-version <APP_VERSION>

Optional new version of the cloned app. Defaults to the current app’s version number.

APP_ID

App identifier

Replaces legacy CLI command “apps-clone”

apps disable

Disable usage of an App

tapis apps disable APP_ID
APP_ID

App identifier

Replaces legacy CLI command “apps-disable”

apps enable

Restore usage for an App if disabled

tapis apps enable APP_ID
APP_ID

App identifier

Replaces legacy CLI command “apps-enable”

Sharing

Manage access by other users to Tapis apps that you control.

apps pems grant

Grant Permissions on an App to a User

tapis apps pems grant
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    APP_ID
    USERNAME
    PERMISSION
--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

-l INT, --limit INT

Limit to N records (default: 100)

-o INT, --offset INT

Skip first N records

APP_ID

App identifier

USERNAME

Tapis username

PERMISSION

Permission string (ALL| READ| WRITE| READ_WRITE| EXECUTE| READ_EXECUTE| WRITE_EXECUTE| NONE)

Replaces legacy CLI command “apps-pems-update”

apps pems list

List Permissions for an specific App

tapis apps pems list
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    APP_ID
--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

-l INT, --limit INT

Limit to N records (default: 100)

-o INT, --offset INT

Skip first N records

APP_ID

App identifier

Replaces legacy CLI command “apps-pems-list”

apps pems revoke

Revoke Permissions on an App for a User

tapis apps pems revoke
    [--sort-ascending | --sort-descending]
    [-l INT]
    [-o INT]
    APP_ID
    USERNAME
--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

-l INT, --limit INT

Limit to N records (default: 100)

-o INT, --offset INT

Skip first N records

APP_ID

App identifier

USERNAME

Tapis username

Replaces legacy CLI command “apps-pems-update”

apps pems show

Show Permissions on an App for specific User

tapis apps pems show APP_ID USERNAME
APP_ID

App identifier

USERNAME

Tapis username

Replaces legacy CLI command “apps-pems-list”

Administration

Manage global settings for a Tapis app.

apps publish

Publish an App for use by others

tapis apps publish
    [-e PUBLIC_EXECUTION_SYSTEM]
    [-n APP_NAME]
    [-x APP_VERSION]
    APP_ID
-e <PUBLIC_EXECUTION_SYSTEM>, --execution-system <PUBLIC_EXECUTION_SYSTEM>

Optional execution system where the public app will run

-n <APP_NAME>, --app-name <APP_NAME>

Optional new name of the public app

-x <APP_VERSION>, --app-version <APP_VERSION>

Optional new version of the public app

APP_ID

App identifier

Replaces legacy CLI command “apps-publish”

apps unpublish

Disable usage of an App

tapis apps unpublish APP_ID
APP_ID

App identifier

Replaces legacy CLI command “apps-disable”

Projects

Create and deploy new apps from a configuration-driven template.

apps init

Initialize a new Tapis App project from a template

tapis apps init
    [--sort-ascending | --sort-descending]
    [-L]
    [-R]
    [-O DIRECTORY]
    [-N STRING]
    [--app-label STRING]
    [--app-description STRING]
    [--app-version N.N.N]
    [--repo URL]
    [--checkout COMMIT]
    [--template TEMPLATE]
--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

-L, --list-templates

List available templates and quit

-R, --dry-run

Show configuration and quit

-O DIRECTORY, --output-dir DIRECTORY

Output directory (default: .)

-N STRING, --app-name STRING

App name (default: new_app)

--app-label STRING

App human-readable label

--app-description STRING

One-sentence description

--app-version N.N.N

App semantic version

--repo URL

Templates repository (https://github.com/TACC-Cloud/cc-tapis-v2-app.git)

--checkout COMMIT

Branch/Tag/Commit (master)

--template TEMPLATE

Template ID (default)

Replaces legacy CLI command “apps-init”

apps deploy

Deploy an App from a project directory

tapis apps deploy
    [--sort-ascending | --sort-descending]
    [-W DIRECTORY]
    [-F FILEPATH]
    [--ini FILEPATH]
    [-R]
    [--ignore-errors]
    [--no-build]
    [--no-pull]
    [--no-push]
    [--backup]
    [--no-upload]
    [--no-create]
    [--no-grant]
    [--no-grant-roles]
    [--display]
--sort-ascending

sort the column(s) in ascending order

--sort-descending

sort the column(s) in descending order

-W DIRECTORY

Working directory

-F FILEPATH, --file FILEPATH

JSON payload file (app.json)

--ini FILEPATH

.ini file (project.ini)

-R, --dry-run

Shortcut: Only build container

--ignore-errors

Ignore deployment errors and warnings

--no-build

Do not build container image

--no-pull

Do not pull source image when building

--no-push

Do not push built container image

--backup

Back up deployment path if present

--no-upload

Do not upload app assets to Tapis storage

--no-create

Do not create a Tapis app record

--no-grant

Do not automatically do application permission grant(s)

--no-grant-roles

Do not automatically do system role grant(s)

--display

Display rendered app in deployment log

Replaces legacy CLI command “apps-deploy”