Skip to main content

Command-line interface for ViUR application maintenance.

Project description

A hexagonal logo of the viur-cli


Badge showing current PyPI version Badge displaying the license
Command-line interface for ViUR framework project maintenance.


viur-cli allows to control, maintain and develop a ViUR project from one central location by using the viur command.

$ viur --help
$ viur init
$ viur create myapp
$ viur run
$ viur deploy app
$ viur deploy index
$ viur vi
$ viur flare watch vi
$ viur env


To use viur-cli in your ViUR projects, install the PyPI package viur-cli.

$ pipenv install --dev viur-cli

Packaged scripts

In order to use the packaged scripts, it is possible to simply run them from the environment that you installed viur-cli into. So if you are using a pipenv, then the scripts will be available in the shell just like you would run viur-cli by calling viur as well.

A handy script that has to be started this way is viur-2to3, which will automatically crawl through a project folder and detect deprecated syntax. It is not only useful for porting viur2 projects to viur3, but also when there are deprecations or breaking changes in viur3! You should start it like this in your project folder:

$ viur-2to3 -d .

This will dry-run the script in the current directory and not make any changes, only suggestions. If you want to make the changes, leave out the -d argument and if you are a daring go-getter and like to live dangerously, replace the -d with -x, which will write the suggested changes without making a backup of the changed files.


If you want to hack viur-cli, clone this repository next to the folder of your ViUR project.

$ git clone
$ ls -1

Then, add it to your project as an editable dependency using

$ cd your-project
$ pipenv install --dev --editable ../viur-cli


viur-cli depends on


Copyright © 2023 by Mausbrand Informationssysteme GmbH.
Mausbrand and ViUR are registered trademarks of Mausbrand Informationssysteme GmbH.

This project is free software under the MIT license.
Please see the LICENSE file for details.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

viur_cli-0.7.8.tar.gz (17.8 kB view hashes)

Uploaded source

Built Distribution

viur_cli-0.7.8-py3-none-any.whl (21.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page