Skip to main content

sos autocomplete install

Install command auto-completion for bash/zsh shells

Description

Enables auto-completion functionality for the signageOS CLI in supported shells. This command adds auto-completion scripts and configuration to the user's shell profile, allowing tab completion for commands and sub-commands.

Usage

sos autocomplete install [options]

Examples

# Install auto-completion
sos autocomplete install

Advanced Usage

Shell Compatibility

signageOS CLI autocomplete supports:

  • Zsh (.zshrc)
  • Bash (.bashrc, .bash_profile)
  • Fish (.config/fish/config.fish)

Setup Process

  1. Install completion script: Adds script to home directory
  2. Configure shell: Adds source line to shell configuration file
  3. Activate immediately: Source the completion script without restart
# Install and activate immediately
sos autocomplete install
source ~/.sos-completion.sh

Usage Examples

# Show all top-level commands
sos [TAB]

# Show all applet subcommands
sos applet [TAB]

# Autocomplete partial commands
sos applet up[TAB] # Completes to "sos applet upload"
sos org l[TAB] # Completes to "sos organization list"

Troubleshooting

If autocomplete isn't working:

# Verify installation
ls -la ~/.sos-completion.sh

# Check shell configuration
grep "sos-completion" ~/.zshrc # or ~/.bashrc

# Reload shell configuration
source ~/.zshrc # or ~/.bashrc

# Reinstall if needed
sos autocomplete uninstall
sos autocomplete install

Since

2.4.0

Global Options

All commands support the following global options:

OptionAliasDescription
--help-hDisplay help information for any command
--version-vDisplay the installed version of the CLI
--api-url-uOverride the API URL for REST requests
--profileUse a specific profile from ~/.sosrc config

Examples

# Show version
sos --version

# Get help for any command
sos applet --help
sos applet upload --help

# Use custom API endpoint
sos --api-url https://api.example.com applet upload

# Use specific profile
sos --profile production organization list