filters

Filters Example

Demonstrates the use of filters that run before a command, and possibly halt its execution.

This example was generated with:

$ bashly init
# ... now edit src/bashly.yml to match the example ...
# ... now edit src/lib/filters.sh to match the example ...
$ bashly generate

---

bashly.yml

name: cli
help: Sample application
version: 0.1.0

commands:
- name: container
  help: Perform actions on a docker container

  # When the command is executed, your script will look for a function named
  # "filter_docker_running" and execute it. If it prints a string, it will be
  # considered an error and the command execution will be halted.
  filters:
  - docker_running

  args:
  - name: id
    required: true
    help: Container ID

- name: redis
  help: Perform actions in redis
  
  # When multiple filters are present, the command will halt if any of them
  # prints an error string.
  filters:
  - docker_running
  - redis_running

src/lib/filters.sh

# These filter functions can reside in any path under the `lib` directory.
# You can use a single file for all filter functions, or a separate file
# for each function.
# Note that the `${args[]}` array is available to you in your filter functions.

# Print an error string if docker is not running.
# The script will automatically exit if this function prints anything.
filter_docker_running() {
  docker info >/dev/null 2>&1 || echo "Docker must be running"
}

# This is just a sample filter designed to always fail
filter_redis_running() {
  echo "Redis must be running (always fails)"
}

Output

$ ./cli container sample-id

# this file is located in 'src/container_command.sh'
# code for 'cli container' goes here
# you can edit it freely and regenerate (it will not be overwritten)
args:
- ${args[id]} = sample-id

$ ./cli redis

Redis must be running (always fails)