Merge pull request #17 from cerc-io/dboreham/consistent-option-names

Make all options use dash word delimiter
This commit is contained in:
David Boreham 2022-10-06 07:55:36 -06:00 committed by GitHub
commit eeb3bfa284
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 4 additions and 4 deletions

View File

@ -119,13 +119,13 @@ Clones the set of git repositories necessary to build a system.
Note: the use of `ssh-agent` is recommended in order to avoid entering your ssh key passphrase for each repository.
```
$ laconic-so --verbose setup-repositories #this will default to ~/cerc or CERC_REPO_BASE_DIR from an env file
#$ ./laconic-so --verbose --local_stack setup-repositories #this will use cwd ../ as dev_root_path
#$ ./laconic-so --verbose --local-stack setup-repositories #this will use cwd ../ as dev_root_path
```
### Build Containers
Builds the set of docker container images required to run a system. It takes around 10 minutes to build all the containers from cold.
```
$ laconic-so --verbose build-containers #this will default to ~/cerc or CERC_REPO_BASE_DIR from an env file
#$ ./laconic-so --verbose --local_stack build-containers #this will use cwd ../ as dev_root_path
#$ ./laconic-so --verbose --local-stack build-containers #this will use cwd ../ as dev_root_path
```
### Deploy System

2
cli.py
View File

@ -34,7 +34,7 @@ class Options(object):
@click.option('--quiet', is_flag=True, default=False)
@click.option('--verbose', is_flag=True, default=False)
@click.option('--dry-run', is_flag=True, default=False)
@click.option('--local_stack', is_flag=True, default=False)
@click.option('--local-stack', is_flag=True, default=False)
# See: https://click.palletsprojects.com/en/8.1.x/complex/#building-a-git-clone
@click.pass_context
def cli(ctx, quiet, verbose, dry_run, local_stack):

View File

@ -5,4 +5,4 @@ source ./venv/bin/activate
pip install --editable .
pip install shiv
shiv -c laconic-so -o laconic-so .
./laconic-so --verbose --local_stack setup-repositories
./laconic-so --verbose --local-stack setup-repositories