command-private

Private Command Example

Demonstrates how to hide a command from the commands list.

This example was generated with:

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

---

bashly.yml

name: cli
help: Sample application with private commands
version: 0.1.0

commands:
- name: connect
  alias: c
  help: Connect to the metaverse

  args:
  - name: protocol
    required: true
    allowed: [ftp, ssh]
    help: Protocol to use for connection

# These two commands will be hidden from the commands list, but still executable
# and visible when running 'cli connect-ftp --help' or 'cli connect-ssh --help'
- name: connect-ftp
  help: Connect via FTP
  private: true

- name: connect-ssh
  help: Connect via SSH
  private: true

src/connect_command.sh

# Execute a subsequent (private) command based on the PROTOCOL argument
protocol=${args[protocol]}
cmd="./cli connect-$protocol"
echo "=== Calling $cmd"
$cmd

Output

$ ./cli

cli - Sample application with private commands

Usage:
  cli COMMAND
  cli [COMMAND] --help | -h
  cli --version | -v

Commands:
  connect       Connect to the metaverse

$ ./cli -h

cli - Sample application with private commands

Usage:
  cli COMMAND
  cli [COMMAND] --help | -h
  cli --version | -v

Commands:
  connect       Connect to the metaverse

Options:
  --help, -h
    Show this help

  --version, -v
    Show version number

$ ./cli connect ftp

=== Calling ./cli connect-ftp
# This file is located at 'src/connect_ftp_command.sh'.
# It contains the implementation for the 'cli connect-ftp' command.
# The code you write here will be wrapped by a function named 'cli_connect_ftp_command()'.
# Feel free to edit this file; your changes will persist when regenerating.
args: none

$ ./cli connect-ssh

# This file is located at 'src/connect_ssh_command.sh'.
# It contains the implementation for the 'cli connect-ssh' command.
# The code you write here will be wrapped by a function named 'cli_connect_ssh_command()'.
# Feel free to edit this file; your changes will persist when regenerating.
args: none

$ ./cli connect-ftp --help

cli connect-ftp - Connect via FTP

Usage:
  cli connect-ftp
  cli connect-ftp --help | -h

Options:
  --help, -h
    Show this help