---
id: autocomplete-install-index
title: install
sidebar_position: 3011
---
# 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

```bash
sos autocomplete install [options]
```

## Examples

```bash
# 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

```bash
# Install and activate immediately
sos autocomplete install
source ~/.sos-completion.sh
```

### Usage Examples

```bash
# 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:

```bash
# 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:

| Option | Alias | Description |
|--------|-------|-------------|
| `--help` | `-h` | Display help information for any command |
| `--version` | `-v` | Display the installed version of the CLI |
| `--api-url` | `-u` | Override the API URL for REST requests |
| `--profile` | | Use a specific profile from ~/.sosrc config |

### Examples

```bash
# 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
```


## See Also

- [Uninstall auto-completion command](../uninstall/)