Diese Seite wird automatisch aus den Click-Definitionen in viur_cli generiert. Jeder --help-Text, jedes Argument, jede Option, die im Code dokumentiert ist, erscheint hier ohne manuelle Pflege.

viur¶

Manage and operate ViUR projects from a single command line.

Reads project.json for per-profile settings (deploy targets, build pipelines, packaged ViUR frontends). Run viur project list to see the resolved configuration of a profile.

Usage:

viur [OPTIONS] COMMAND [ARGS]...

Options:

  --version   Show the version and exit.
  -h, --help  Show this message and exit.

Subcommands

• admin: Manage the admin Vue.js CMS bundle.
• autocomplete-info: Show autocompletion status and instructions.
• build: Build deploy artifacts (npm bundles, exec build steps) for a ViUR project.
• check: Audit Python (pip-audit) and npm (npm audit) dependencies for known vulnerabilities.
• cloud: Manage Google Cloud resources for a ViUR project (deploy, IAM, backup, datastore).
• create: Clone viur-base into ./NAME and run its clean-base.py setup wizard.
• env: Print the resolved profile and the versions of CLI tools used by ViUR development.
• package: [DEPRECATED] Use 'viur ' instead.
• project: Inspect the resolved project.json configuration for a profile.
• run: Start the application locally via app_server (requires an active gcloud login).
• script: Pull, push, and run ViUR Scriptor scripts against a deployed app.
• scriptor: Manage the scriptor frontend asset bundle.
• setup-autocomplete: Install shell tab-completion for the viur CLI.
• uninstall-autocomplete: Remove shell autocompletion for the viur CLI.
• update: Regenerate project-managed deploy files (currently deploy/requirements.txt).
• vi: Manage the legacy 'vi' frontend bundle.

admin¶

Manage the admin Vue.js CMS bundle.

Usage:

viur admin [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

Subcommands

• install: Install or replace admin at the given version (default: latest).
• update: Update admin to the latest version.

install¶

Install or replace admin at the given version (default: latest).

Usage:

viur admin install [OPTIONS] [VERSION] [PROFILE]

Options:

  -h, --help  Show this message and exit.

update¶

Update admin to the latest version.

Usage:

viur admin update [OPTIONS] [PROFILE]

Options:

  -h, --help  Show this message and exit.

autocomplete-info¶

Show autocompletion status and instructions.

Usage:

viur autocomplete-info [OPTIONS]

Options:

  -h, --help  Show this message and exit.

build¶

Build deploy artifacts (npm bundles, exec build steps) for a ViUR project.

Usage:

viur build [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

Subcommands

• app: Build a single application from the profile's builds section.
• clean: Drop build artifacts for one application (TARGET) or for all builds in the profile.
• release: Build every entry in the profile's builds section, in declaration order.

app¶

Build a single application from the profile's builds section.

Usage:

viur build app [OPTIONS] APPNAME [ADDITIONAL_ARGS]... [PROFILE]

Options:

  -h, --help  Show this message and exit.

clean¶

Drop build artifacts for one application (TARGET) or for all builds in the profile.

Usage:

viur build clean [OPTIONS] [TARGET] [PROFILE]

Options:

  -h, --help  Show this message and exit.

release¶

Build every entry in the profile's builds section, in declaration order.

Usage:

viur build release [OPTIONS] [PROFILE] [ADDITIONAL_ARGS]...

Options:

  -h, --help  Show this message and exit.

check¶

Audit Python (pip-audit) and npm (npm audit) dependencies for known vulnerabilities.

Usage:

viur check [OPTIONS]

Options:

  -d, --dev
  -h, --help  Show this message and exit.

cloud¶

Manage Google Cloud resources for a ViUR project (deploy, IAM, backup, datastore).

Usage:

viur cloud [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

Subcommands

• cleanup: Run gcloud datastore indexes cleanup against deploy/index.yaml.
• copy: Copy data between Cloud Storage buckets or between bucket and Datastore.
• create: Add a cloudfunction entry to project.json (interactive prompts for missing fields).
• deploy: Deploy app, index, cron, queue, or a cloudfunction to Google Cloud.
• disable: Disable an optional cloud feature on the active project (currently only backup).
• enable: Enable an optional cloud feature on the active project (currently only backup).
• get: Read information from the active cloud project (currently: IAM roles).
• init: Bootstrap a fresh project on GCP by deploying its cron and queue configs.
• setup: Apply IAM-role bindings from <profile>_roles.json back to the project.

cleanup¶

Run gcloud datastore indexes cleanup against deploy/index.yaml.

Usage:

viur cloud cleanup [OPTIONS] [[gcloud]] [[datastore]] [PROFILE]

Options:

  -h, --help  Show this message and exit.

copy¶

Copy data between Cloud Storage buckets or between bucket and Datastore.

Usage:

viur cloud copy [OPTIONS] {bucket2bucket|bucket2local|local2bucket} [PROFILE]

Options:

  -h, --help  Show this message and exit.

create¶

Add a cloudfunction entry to project.json (interactive prompts for missing fields).

Each unset CLI option falls back to a click.prompt. The result is persisted under gcloud.functions.<name> in the active profile.

Usage:

viur cloud create [OPTIONS] {function} [PROFILE]

Options:

  -g, --gen TEXT
  -src, --source TEXT
  -n, --name TEXT
  -ep, --entrypoint TEXT
  -ev, --env-vars-file TEXT
  -mem, --memory TEXT
  -rt, --runtime TEXT
  -tr, --trigger TEXT
  -h, --help                 Show this message and exit.

deploy¶

Deploy app, index, cron, queue, or a cloudfunction to Google Cloud.

Examples: viur cloud deploy app dev viur cloud deploy index live --yes viur cloud deploy cloudfunction dev --name=billing viur cloud deploy app dev --skip_checks --ext=hotfix-2026-05-05

Action-specific behaviour:

• app runs viur check first (unless --skip_checks) and then gcloud app deploy against conf['distribution_folder']. The version label resolves $(...) variables in project.json's version field. --ext appends a suffix.
• index reads deploy/index.yaml and sorts/dedupes index definitions by kind before deploy.
• cron / queue deploy the matching deploy/<action>.yaml.
• cloudfunction requires --name to point at a function entry defined in project.json under gcloud.functions.

Usage:

viur cloud deploy [OPTIONS] {app|index|cron|queue|cloudfunction} [PROFILE]
                  [ADDITIONAL_ARGS]...

Options:

  -e, --ext TEXT
  -y, --yes
  --skip_checks    Skip the security checks before the deployment
  -n, --name TEXT
  -h, --help       Show this message and exit.

disable¶

Disable an optional cloud feature on the active project (currently only backup).

Usage:

viur cloud disable [OPTIONS] {backup}

Options:

  -h, --help  Show this message and exit.

enable¶

Enable an optional cloud feature on the active project (currently only backup).

Usage:

viur cloud enable [OPTIONS] {backup}

Options:

  -h, --help  Show this message and exit.

get¶

Read information from the active cloud project (currently: IAM roles).

Usage:

viur cloud get [OPTIONS] {gcroles} [PROFILE]

Options:

  -h, --help  Show this message and exit.

init¶

Bootstrap a fresh project on GCP by deploying its cron and queue configs.

Usage:

viur cloud init [OPTIONS] [[gcloud]] [PROFILE]

Options:

  -h, --help  Show this message and exit.

setup¶

Apply IAM-role bindings from <profile>_roles.json back to the project.

Usage:

viur cloud setup [OPTIONS] {gcroles} [PROFILE]

Options:

  -h, --help  Show this message and exit.

create¶

Clone viur-base into ./NAME and run its clean-base.py setup wizard.

Optionally chains into ./viur-gcloud-setup.sh NAME if confirmed, so the project is wired to a fresh GCP project in one shot.

Usage:

viur create [OPTIONS] NAME

Options:

  -h, --help  Show this message and exit.

env¶

Print the resolved profile and the versions of CLI tools used by ViUR development.

Usage:

viur env [OPTIONS] [PROFILE]

Options:

  -h, --help  Show this message and exit.

package¶

[DEPRECATED] Use 'viur ' instead.

The 'viur package …' surface is kept for backwards compatibility and will be removed in v3.2. Prefer 'viur admin install', 'viur scriptor update', etc.

Usage:

viur package [OPTIONS] {update|install} {vi|admin|scriptor|all} [VERSION]
             [PROFILE]

Options:

  -h, --help  Show this message and exit.

project¶

Inspect the resolved project.json configuration for a profile.

Usage:

viur project [OPTIONS] {list} [PROFILE]

Options:

  -h, --help  Show this message and exit.

run¶

Start the application locally via app_server (requires an active gcloud login).

Resolves application_name from the profile and forwards --appyaml, --port and --gunicorn_port to app_server if they are set.

Usage:

viur run [OPTIONS] [PROFILE] [ADDITIONAL_ARGS]...

Options:

  -h, --help  Show this message and exit.

script¶

Pull, push, and run ViUR Scriptor scripts against a deployed app.

Usage:

viur script [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

Subcommands

• configure: Update Scriptor connection settings (base URL, username, working dir).
• pull: Download all server-side Scriptor scripts into the local working_dir.
• push: Upload local working_dir scripts to the server.
• run: Execute working_dir/PATH locally with the configured Scriptor session.
• setup: Authenticate against the configured Scriptor base URL and persist the session.

configure¶

Update Scriptor connection settings (base URL, username, working dir).

Only flags that are passed are written; the rest of the viur_scriptor_config.json keeps its previous values.

Usage:

viur script configure [OPTIONS]

Options:

  --url TEXT          Set the url
  --username TEXT     Set the username
  --working_dir TEXT  Set the working directory where scripts are stored to
  -h, --help          Show this message and exit.

pull¶

Download all server-side Scriptor scripts into the local working_dir.

Existing files with diverging content prompt for confirmation before being overwritten, unless --force is set.

Usage:

viur script pull [OPTIONS]

Options:

  --force BOOLEAN  Force replace files from server in local working directory
  -h, --help       Show this message and exit.

push¶

Upload local working_dir scripts to the server.

Skips files whose SHA-256 already matches the server-side copy. With --watch the command stays running and re-pushes any file that changes on disk.

Usage:

viur script push [OPTIONS]

Options:

  -f, --force  Force push files from the local working directory onto the
               server
  -w, --watch  Watch for file changes in the script folder and push them to
               the server
  -h, --help   Show this message and exit.

run¶

Execute working_dir/PATH locally with the configured Scriptor session.

Usage:

viur script run [OPTIONS] PATH [ARGS]...

Options:

  -h, --help  Show this message and exit.

setup¶

Authenticate against the configured Scriptor base URL and persist the session.

Tries SSO via :func:ensure_login first (requires viur-core ≥ 3.8.19); falls back to user+password prompt and stores the resulting cookies in viur_scriptor_config.json for subsequent viur script pull/push/run.

Usage:

viur script setup [OPTIONS]

Options:

  -h, --help  Show this message and exit.

scriptor¶

Manage the scriptor frontend asset bundle.

Asset-bundle install for the SPA shipped alongside admin. Not to be confused with viur script (which pulls/pushes Scriptor scripts against a deployed app).

Usage:

viur scriptor [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

Subcommands

• install: Install or replace the scriptor frontend at the given version.
• update: Update the scriptor frontend to the latest version.

install¶

Install or replace the scriptor frontend at the given version.

Usage:

viur scriptor install [OPTIONS] [VERSION] [PROFILE]

Options:

  -h, --help  Show this message and exit.

update¶

Update the scriptor frontend to the latest version.

Usage:

viur scriptor update [OPTIONS] [PROFILE]

Options:

  -h, --help  Show this message and exit.

setup-autocomplete¶

Install shell tab-completion for the viur CLI.

Generates Click's completion script for the chosen shell and writes it next to the shell's rc file (sourcing it from ~/.bashrc / ~/.zshrc, or directly into fish's completions dir).

Args: shell: bash, zsh, fish, or auto (detect from $SHELL).

Usage:

viur setup-autocomplete [OPTIONS]

Options:

  --shell [bash|zsh|fish|auto]  Shell type (auto-detect if not specified)
  -h, --help                    Show this message and exit.

uninstall-autocomplete¶

Remove shell autocompletion for the viur CLI.

Usage:

viur uninstall-autocomplete [OPTIONS]

Options:

  -h, --help  Show this message and exit.

update¶

Regenerate project-managed deploy files (currently deploy/requirements.txt).

Examples: viur update requirements viur update requirements live

Usage:

viur update [OPTIONS] {requirements} [PROFILE] [ADDITIONAL_ARGS]...

Options:

  -h, --help  Show this message and exit.

vi¶

Manage the legacy 'vi' frontend bundle.

Usage:

viur vi [OPTIONS] COMMAND [ARGS]...

Options:

  -h, --help  Show this message and exit.

Subcommands

• install: Install or replace vi at the given version (default: latest).
• update: Update vi to the latest version.

install¶

Install or replace vi at the given version (default: latest).

Usage:

viur vi install [OPTIONS] [VERSION] [PROFILE]

Options:

  -h, --help  Show this message and exit.

update¶

Update vi to the latest version.

Usage:

viur vi update [OPTIONS] [PROFILE]

Options:

  -h, --help  Show this message and exit.