cloudstic completion

​

Usage

cloudstic completion <shell>

​

Supported Shells

• bash: Bourne Again Shell
• zsh: Z Shell
• fish: Friendly Interactive Shell

​

Installation

# Bash
cloudstic completion bash

# Zsh
cloudstic completion zsh

# Fish
cloudstic completion fish

source <(cloudstic completion bash)

# Add to ~/.bashrc or ~/.bash_profile
echo 'source <(cloudstic completion bash)' >> ~/.bashrc

cloudstic completion bash > /etc/bash_completion.d/cloudstic

source <(cloudstic completion zsh)

# Add to ~/.zshrc
echo 'source <(cloudstic completion zsh)' >> ~/.zshrc

cloudstic completion zsh > "${fpath[1]}/_cloudstic"

cloudstic completion fish | source

# Fish automatically loads completions from ~/.config/fish/completions/
cloudstic completion fish > ~/.config/fish/completions/cloudstic.fish

exec $SHELL

exec fish

cloudstic <TAB>
# Shows: init backup auth store source setup tui profile restore list ls
# prune forget diff break-lock key check cat completion version help

​

Features

​

Commands and Subcommands

cloudstic <TAB>
# Shows all available commands

cloudstic key <TAB>
# Shows: list add-recovery passwd

​

Flags and Options

cloudstic backup -<TAB>
# Shows: -source -tag -dry-run
# Plus all global flags

cloudstic init -<TAB>
# Shows: -add-recovery-key -no-encryption
# Plus all global flags

​

Flag Values

cloudstic backup -source <TAB>
# Shows: local sftp gdrive gdrive-changes onedrive onedrive-changes

cloudstic -store <TAB>
# Shows: local b2 s3 sftp

​

File Path Completion

cloudstic restore -output <TAB>
# Shows file completions

​

Context-Aware Completions

cloudstic backup -source local:<TAB>
# Shows directory completions for the local source path

cloudstic key passwd -<TAB>
# Shows: -new-password (plus global flags)

​

Dynamic Completion for Profiles and Auth Entries

cloudstic backup -profile <TAB>
# Shows every profile name currently defined in profiles.yaml

cloudstic backup -auth-ref <TAB>
# Shows every auth entry name currently defined in profiles.yaml

​

Completion Examples

​

Completing Store Types

$ cloudstic backup -store <TAB>
local  b2  s3  sftp

​

Completing Source Types

$ cloudstic backup -source <TAB>
local  sftp  gdrive  gdrive-changes  onedrive  onedrive-changes

​

Completing Subcommands

$ cloudstic <TAB>
init        backup      auth        store       source      setup
tui         profile     restore     list        ls          prune
forget      diff        break-lock  key         check       cat
completion  version     help

​

Completing Shell Types

$ cloudstic completion <TAB>
bash  zsh  fish

​

Troubleshooting

​

Bash: Completions not working

1. Ensure bash-completion package is installed:
   # Ubuntu/Debian
   sudo apt-get install bash-completion
   
   # macOS
   brew install bash-completion@2
   
2. Verify bash-completion is loaded in your .bashrc:
   # Add if missing
   if [ -f /etc/bash_completion ]; then
     . /etc/bash_completion
   fi
   

​

Zsh: Command not found: compdef

1. Enable compinit in your .zshrc before sourcing the completion:
   autoload -Uz compinit
   compinit
   source <(cloudstic completion zsh)
   

​

Fish: Completions not appearing

1. Check that the completion file was created:
   ls ~/.config/fish/completions/cloudstic.fish
   
2. Reload completions:
   fish_update_completions
   

​

General: Old completions cached

# Bash: Clear completion cache
hash -r

# Zsh: Clear completion cache
rm ~/.zcompdump*
compinit

# Fish: Reload completions
fish_update_completions

​

Available Completions

​

Global Flags (available in all commands)

• -store → URI completion (shows format hints: local:, s3:, b2:, sftp://)
• -s3-endpoint → free text
• -s3-region → free text
• -s3-access-key → free text
• -s3-secret-key → free text
• -store-sftp-password → free text
• -store-sftp-key → file path completion
• -store-sftp-known-hosts → file path completion
• -store-sftp-insecure → boolean flag
• -source-sftp-password → free text
• -source-sftp-key → file path completion
• -source-sftp-known-hosts → file path completion
• -source-sftp-insecure → boolean flag
• -encryption-key → free text
• -password → free text
• -recovery-key → free text
• -kms-key-arn → free text
• -disable-packfile → boolean flag
• -verbose → boolean flag
• -quiet → boolean flag
• -debug → boolean flag

​

Command-Specific Flags

• -add-recovery-key
• -no-encryption

• -source → local, sftp, gdrive, gdrive-changes, onedrive, onedrive-changes
• -tag → free text (repeatable)
• -ignore-empty-snapshot
• -dry-run

• -output → file or directory path completion (default: ./restore.zip)
• -format → zip or dir
• -path → free text
• -dry-run

• -dry-run

• -prune
• -dry-run
• -keep-last → number
• -keep-hourly → number
• -keep-daily → number
• -keep-weekly → number
• -keep-monthly → number
• -keep-yearly → number
• -tag → free text (repeatable)
• -source → free text
• -account → free text
• -path → free text
• -group-by → free text (default: source,account,path)

• -json

• -new-password → free text

• -read-data

​

Notes

• Performance: Completions are generated dynamically based on the current command context
• File completions: File and directory paths use native shell completion capabilities
• No external dependencies: Completion scripts are self-contained and don’t require network access
• Automatic updates: Regenerate completions after upgrading Cloudstic to get the latest commands and flags

​

Related Commands

• : Display usage information
• : Print version information