Skip to content
Seafoam Labs

Shelly CLI Reference

Shelly CLI Documentation

Auto-generated by shelly docs.

Overview

Shelly — a modern, unified package manager for Arch Linux. Install, update, search, and manage standard (ALPM) packages, the AUR, Flatpaks, and AppImages from a single command-line interface.

Direct Commands (shelly)

Command Description
query [package] Query repositories and packages. Includes installed and available by default.
install [packages…] Install packages
upgrade Perform a full system upgrade
upgrade-all Upgrade all packages from every source (repo, AUR, Flatpak, AppImage)
downgrade [package] Downgrade a package
ignore [packages…] Manage ignored packages
news Show ArchLinux news
cache-clean Clean the local cache
check-updates Check for package updates
list-updates List standard packages that have available updates
export Export the current system state to a file
fix-permissions Fix permissions for Shelly directories
mark [package] Mark a package as explicit or a dependency
pacfile [pacfiles…] Manage pacfiles
purify Remove corrupted/orphaned packages
remove [packages…] Remove packages (repo or local binary)
sync Syncs the system with the current state
update [packages…] Update specific packages
docs Generate Markdown reference documentation for the Shelly CLI
completions Generate shell completion scripts
keyring [keys…] Manage the pacman keyring

Manage AppImages (shelly appimage)

Command Description
appimage install Install an AppImage
appimage remove Remove an AppImage
appimage list Lists all AppImages
appimage upgrade Upgrades all AppImages
appimage sync-meta [package] Syncs meta data for an AppImage
appimage list-updates Find Updates for an AppImage
appimage configure-updates Configures the update settings for an AppImage
appimage migrate-manager Updates the AppImage manager version

Manage shelly configuration (shelly config)

Command Description
config get Get a configuration value
config set Set a configuration value
config list List all configuration values
config reset Reset the configuration to defaults
config parallel Set the number of parallel downloads

Manage AUR packages (shelly aur)

Command Description
aur install [packages…] Install AUR packages
aur install-version Install a specific version of an AUR package
aur remove [packages…] Remove AUR packages
aur update [packages…] Rebuild and reinstall specific AUR packages
aur upgrade Upgrade all out-of-date AUR packages
aur list List installed AUR packages
aur list-updates List AUR packages that have available updates
aur search <query…> Search the Arch User Repository
aur search-pkgbuild <packages…> Fetch and display the PKGBUILD of AUR packages

Manage flatpak (shelly flatpak)

Command Description
flatpak install Install flatpak app
flatpak update Update flatpak app
flatpak list List installed flatpak apps
flatpak list-updates List flatpak apps with updates
flatpak running List running flatpak apps
flatpak repair Repairs Flatpak Installation
flatpak uninstall Remove flatpak app
flatpak run Run flatpak app
flatpak kill Kill running flatpak app
flatpak search Search flatpak
flatpak sync-remote-appstream Sync remote appstream
flatpak get-remote-appstream Returns remote appstream json
flatpak upgrade Upgrade all flatpak apps
flatpak list-remotes Returns all remotes currently added
flatpak add-remotes Adds a flatpak remote
flatpak remove-remotes Removes a flatpak remote
flatpak install-ref-file Installs flatpak app from ref file
flatpak install-bundle Installs flatpak app from bundle file
flatpak app-remote-info Get app remote info
flatpak purify Cleans all unused dependencies

Shortcodes

Grammar: -<Type><Action><modifiers...> [positionals]

Type selects the command group, Action selects the verb, and modifiers are that verb’s own short flags (case-sensitive).

Type Group
I appimage
A aur
C config
F flatpak
K keyring
S standard
U utility

Examples:

Terminal window
-SIu firefox   ->  install -u firefox
-AS query      ->  aur search query
-KV ABCD       ->  keyring recv ABCD

In shortcode mode use --ui-mode instead of -U.

Actions by Type

I — appimage

Action Verb Modifiers
I install -
R remove c
L list -
U upgrade -
P list-updates -
S sync-meta -
C configure-updates p
M migrate-manager -

A — aur

Action Verb Modifiers
I install c, m, o
V install-version -
R remove c, i, o
T update -
U upgrade -
L list -
P list-updates -
S search -
B search-pkgbuild -

C — config

Action Verb Modifiers
G get -
S set -
L list -
R reset -
P parallel -

F — flatpak

Action Verb Modifiers
I install b, r
T update -
U upgrade -
L list -
P list-updates -
R uninstall c, r
N running -
X run -
K kill -
S search l, p
H repair -
M list-remotes -
A add-remotes g, s, u
D remove-remotes s
E install-ref-file s
B install-bundle s
Y sync-remote-appstream -
G get-remote-appstream -
O app-remote-info -

K — keyring

Action Verb
I init
L list
R refresh
S lsign
P populate
V recv

S — standard

Action Verb Modifiers
I install b, d, m, u
R remove c, i, l, o, r
Q query a, d, i, l, p, r, t, w
M mark d, e
Y sync f
P purify d, o
N news a
D downgrade i, l, o, t
G ignore a, c, l, r
U upgrade -
T update -

U — utility

Action Verb Modifiers
C cache-clean c, d, i, k, t
K check-updates a, c, l
E export a, o
F fix-permissions -

shelly

Shelly — a modern, unified package manager for Arch Linux. Install, update, search, and manage standard (ALPM) packages, the AUR, Flatpaks, and AppImages from a single command-line interface.

Branch command — use one of the subcommands below.

Subcommands:

Usage:

shelly [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly query

Query repositories and packages. Includes installed and available by default.

Usage:

shelly query [package] [options]
Argument Arity Description
<package> 0..1 The package to search for

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--available -a bool No Include available packages in the search
--detail, --info -d bool No Show detailed information for a single package
--installed -i bool No Include installed packages in the search
--local -l bool No Include local packages in the search
--page -p int Yes Page number
--repos -r bool No List available repositories. This supercedes any other modifiers.
--show-hidden -w bool No Show hidden packages
--take -t int Yes Number of results to return

shelly install

Install packages

Usage:

shelly install [packages...] [options]
Argument Arity Description
<packages> 0..100000 The packages to install (repo names, local files or URLs)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--build-deps -b bool No Install build dependencies
--make-deps -m bool No Install make dependencies
--no-deps -d bool No Install without checking/installing dependencies
--upgrade -u bool No Upgrades the packages if they are already installed

shelly upgrade

Perform a full system upgrade

Usage:

shelly upgrade [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly upgrade-all

Upgrade all packages from every source (repo, AUR, Flatpak, AppImage)

Usage:

shelly upgrade-all [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--no-appimage - bool No Skip the AppImage upgrade
--no-aur - bool No Skip the AUR upgrade
--no-flatpak - bool No Skip the Flatpak upgrade
--no-repo - bool No Skip the standard repository (ALPM) upgrade

shelly downgrade

Downgrade a package

Usage:

shelly downgrade [package] [options]
Argument Arity Description
<package> 0..1 The package to downgrade

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--ignore -i bool No Add to IgnorePkg list
--list-options -l bool No List available downgrade versions
--oldest -o bool No Installs the oldest matched version (default newest)
--target -t string Yes Install a specific downgrade target by exact version or package filename

shelly ignore

Manage ignored packages

Usage:

shelly ignore [packages...] [options]
Argument Arity Description
<packages> 0..100000 The packages to interact with

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--add -a bool No Add a package to the ignore list
--clear -c bool No Clear the ignore list
--list -l bool No List ignored packages
--remove -r bool No Remove a package from the ignore list

shelly news

Show ArchLinux news

Usage:

shelly news [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--all -a bool No Show all news, not just news you haven’t seen before.

shelly cache-clean

Clean the local cache

Usage:

shelly cache-clean [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--cache-dir -c string Yes Path to the cache directory.
--dry-run -d bool No Show what would be removed.
--keep -k int Yes Keep the specified number of versions in the cache. Defaults to 3.
--target -t string[] Yes Remove only the specified packages from the cache.
--uninstalled -i bool No Remove only uninstalled packages from the cache.

shelly check-updates

Check for package updates

Usage:

shelly check-updates [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--aur -a bool No Check for AUR updates
--count -c bool No Returns the number of updates
--flatpak -l bool No Check for Flatpak updates

shelly list-updates

List standard packages that have available updates

Usage:

shelly list-updates [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly export

Export the current system state to a file

Usage:

shelly export [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--name -a string Yes The name of the exported file
--output -o string Yes The default output location for the sync file

shelly fix-permissions

Fix permissions for Shelly directories

Usage:

shelly fix-permissions [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly mark

Mark a package as explicit or a dependency

Usage:

shelly mark [package] [options]
Argument Arity Description
<package> 0..1 The package to mark

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--depends -d bool No Mark the package as a dependency
--explicit -e bool No Mark the package as explicit

shelly pacfile

Manage pacfiles

Usage:

shelly pacfile [pacfiles...] [options]
Argument Arity Description
<pacfiles> 0..100000 Pacfile names, defaults to all pacfiles if not specified

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly purify

Remove corrupted/orphaned packages

Usage:

shelly purify [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--dry-run -d bool No Show what would be removed without removing it.
--orphans -o bool No Also remove orphaned dependencies.

shelly remove

Remove packages (repo or local binary)

Usage:

shelly remove [packages...] [options]
Argument Arity Description
<packages> 0..100000 The packages to remove (repo names or local binary packages)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--cascade -c bool No Removes all things the removed package(s) are dependent on that have no other uses (default: true)
--local -l bool No Force removal as a locally-installed binary package
--opt-deps -o bool No Removes optional dependencies installed with the package, that don’t depend on other packages
--remove-config -r bool No Removes any files in your ~/.config that can be tied exclusively to the removed package(s). EXPERIMENTAL
--ripple -i bool No Removes packages that depend on the package being removed

shelly sync

Syncs the system with the current state

Usage:

shelly sync [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--force -f bool No Force a sync

shelly update

Update specific packages

Usage:

shelly update [packages...] [options]
Argument Arity Description
<packages> 0..100000 The packages to update

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly docs

Generate Markdown reference documentation for the Shelly CLI

Usage:

shelly docs [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly completions

Generate shell completion scripts

Usage:

shelly completions <shell> [options]
Argument Arity Description
<shell> 1 The shell to generate completions for (fish, zsh)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly appimage

Manage AppImages

Branch command — use one of the subcommands below.

Subcommands:

Usage:

shelly appimage [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly appimage install

Install an AppImage

Usage:

shelly appimage install <location> [options]
Argument Arity Description
<location> 1 Location of the AppImage

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly appimage remove

Remove an AppImage

Usage:

shelly appimage remove <appimage> [options]
Argument Arity Description
<appimage> 1 Name of the AppImage

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--remove-config -c bool No Remove Config

shelly appimage list

Lists all AppImages

Usage:

shelly appimage list [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly appimage upgrade

Upgrades all AppImages

Usage:

shelly appimage upgrade [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly appimage sync-meta

Syncs meta data for an AppImage

Usage:

shelly appimage sync-meta [package] [options]
Argument Arity Description
<package> 0..1 The search query for the AppImage

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly appimage list-updates

Find Updates for an AppImage

Usage:

shelly appimage list-updates [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly appimage configure-updates

Configures the update settings for an AppImage

Usage:

shelly appimage configure-updates <appimage> <url> <type> [options]
Argument Arity Description
<appimage> 1 AppImage name to configure updates
<url> 1 Update URL
<type> 1 Update Type

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--prerelease -p bool No Allow prerelease updates

shelly appimage migrate-manager

Updates the AppImage manager version

Usage:

shelly appimage migrate-manager [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly config

Manage shelly configuration

Branch command — use one of the subcommands below.

Subcommands:

Usage:

shelly config [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly config get

Get a configuration value

Usage:

shelly config get <key> [options]
Argument Arity Description
<key> 1 The configuration key to get

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly config set

Set a configuration value

Usage:

shelly config set <key> <value> [options]
Argument Arity Description
<key> 1 The configuration key to set
<value> 1 The value to set

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly config list

List all configuration values

Usage:

shelly config list [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly config reset

Reset the configuration to defaults

Usage:

shelly config reset [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly config parallel

Set the number of parallel downloads

Usage:

shelly config parallel <downloadCount> [options]
Argument Arity Description
<downloadCount> 1 The number of parallel downloads

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly aur

Manage AUR packages

Branch command — use one of the subcommands below.

Subcommands:

Usage:

shelly aur [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly aur install

Install AUR packages

Usage:

shelly aur install [packages...] [options]
Argument Arity Description
<packages> 0..100000 One or more AUR package names to operate on (space-separated)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--build-deps -o bool No Install build dependencies only for the specified AUR packages
--check - bool No Run the check() function during AUR package builds (disabled by default)
--chroot -c bool No Build packages in a clean chroot environment using makechrootpkg
--make-deps -m bool No Install make dependencies only for the specified AUR packages

shelly aur install-version

Install a specific version of an AUR package

Usage:

shelly aur install-version <package> <commit> [options]
Argument Arity Description
<package> 1 Name of the AUR package to install
<commit> 1 Git commit hash specifying the exact version to install

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--check - bool No Run the check() function during AUR package builds (disabled by default)

shelly aur remove

Remove AUR packages

Usage:

shelly aur remove [packages...] [options]
Argument Arity Description
<packages> 0..100000 One or more AUR package names to operate on (space-separated)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--cascade -c bool No Removes all things the removed package(s) are dependent on that have no other uses (default: true)
--opt-deps -o bool No Removes optional dependencies installed with the package, that don’t depend on other packages
--ripple -i bool No Removes packages that depend on the package being removed

shelly aur update

Rebuild and reinstall specific AUR packages

Usage:

shelly aur update [packages...] [options]
Argument Arity Description
<packages> 0..100000 One or more AUR package names to operate on (space-separated)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--check - bool No Run the check() function during AUR package builds (disabled by default)

shelly aur upgrade

Upgrade all out-of-date AUR packages

Usage:

shelly aur upgrade [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--check - bool No Run the check() function during AUR package builds (disabled by default)
--singlepane - bool No Render output as a single pacman-style linear stream

shelly aur list

List installed AUR packages

Usage:

shelly aur list [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--show-hidden - bool No Include hidden packages in the listing

shelly aur list-updates

List AUR packages that have available updates

Usage:

shelly aur list-updates [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--show-hidden - bool No Include hidden packages in the listing

Search the Arch User Repository

Usage:

shelly aur search <query...> [options]
Argument Arity Description
<query> 1..100000 Search term to find packages in the Arch User Repository

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly aur search-pkgbuild

Fetch and display the PKGBUILD of AUR packages

Usage:

shelly aur search-pkgbuild <packages...> [options]
Argument Arity Description
<packages> 1..100000 One or more AUR package names to fetch the PKGBUILD for

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly keyring

Manage the pacman keyring

Usage:

shelly keyring <action> [keys...] [options]
Argument Arity Description
<action> 1 The keyring action to perform
<keys> 0..100000 The key IDs to operate on

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--keyserver - string Yes The keyserver to use

shelly flatpak

Manage flatpak

Branch command — use one of the subcommands below.

Subcommands:

Usage:

shelly flatpak [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak install

Install flatpak app

Usage:

shelly flatpak install <package> [options]
Argument Arity Description
<package> 1 Flatpak application ID (e.g., com.spotify.Client)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--branch -b string Yes Branch to install (e.g., stable, beta). Defaults to stable
--remote -r string Yes Remote to install from (e.g., flathub, flathub-beta)
--runtime - bool No Install as a runtime instead of an application
--user - bool No Install to user scope instead of system scope

shelly flatpak update

Update flatpak app

Usage:

shelly flatpak update <package> [options]
Argument Arity Description
<package> 1 Flatpak application ID (e.g., com.spotify.Client)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak list

List installed flatpak apps

Usage:

shelly flatpak list [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak list-updates

List flatpak apps with updates

Usage:

shelly flatpak list-updates [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak running

List running flatpak apps

Usage:

shelly flatpak running [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak repair

Repairs Flatpak Installation

Usage:

shelly flatpak repair [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak uninstall

Remove flatpak app

Usage:

shelly flatpak uninstall <package> [options]
Argument Arity Description
<package> 1 Flatpak application ID (e.g., com.spotify.Client)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--config -c bool No Removes flatpak configuration for removed app
--remove-unused -r bool No Remove unused dependencies after uninstalling

shelly flatpak run

Run flatpak app

Usage:

shelly flatpak run <package> [options]
Argument Arity Description
<package> 1 Flatpak application ID (e.g., com.spotify.Client)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak kill

Kill running flatpak app

Usage:

shelly flatpak kill <package> [options]
Argument Arity Description
<package> 1 Flatpak application ID (e.g., com.spotify.Client)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

Search flatpak

Usage:

shelly flatpak search <query> [options]
Argument Arity Description
<query> 1 Search term to find Flatpak applications on Flathub

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--limit -l int Yes Maximum number of search results to display per page
--page -p int Yes Page number for paginated results (starts at 1)

shelly flatpak sync-remote-appstream

Sync remote appstream

Usage:

shelly flatpak sync-remote-appstream [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak get-remote-appstream

Returns remote appstream json

Usage:

shelly flatpak get-remote-appstream <query> [options]
Argument Arity Description
<query> 1 Gets appstream data in json (use all to retrieve all appstreams)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak upgrade

Upgrade all flatpak apps

Usage:

shelly flatpak upgrade [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak list-remotes

Returns all remotes currently added

Usage:

shelly flatpak list-remotes [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak add-remotes

Adds a flatpak remote

Usage:

shelly flatpak add-remotes <remote> [options]
Argument Arity Description
<remote> 1 Flatpak remote name ID (e.g., flathub)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--gpg-verify -g bool No Enable GPG verification for the remote
--remote-url -u string Yes Flatpak remote URL
--system -s bool No Add the remote system-wide

shelly flatpak remove-remotes

Removes a flatpak remote

Usage:

shelly flatpak remove-remotes <remote> [options]
Argument Arity Description
<remote> 1 Flatpak remote name ID (e.g., flathub)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--system -s bool No Remove the remote system-wide

shelly flatpak install-ref-file

Installs flatpak app from ref file

Usage:

shelly flatpak install-ref-file <RefFilePath> [options]
Argument Arity Description
<RefFilePath> 1 Path to the ref file

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--system -s bool No Install system-wide

shelly flatpak install-bundle

Installs flatpak app from bundle file

Usage:

shelly flatpak install-bundle <BundlePath> [options]
Argument Arity Description
<BundlePath> 1 Path to the .flatpak bundle file

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
--system -s bool No Install system-wide

shelly flatpak app-remote-info

Get app remote info

Usage:

shelly flatpak app-remote-info <remote> <id> <branch> [options]
Argument Arity Description
<remote> 1 Flatpak remote name (e.g., flathub)
<id> 1 Flatpak application ID
<branch> 1 Branch to query (e.g., stable)

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information

shelly flatpak purify

Cleans all unused dependencies

Usage:

shelly flatpak purify [options]

Options:

Option Alias Type Required Description
--json -j bool No Output results in JSON format for scripting.
--no-confirm -n bool No Disable confirmation prompts
--ui-mode -U bool No Enable UI mode
--verbose -v bool No Enable verbose logging.
--version - void No Show version information
© 2026 Seafoam LabsShelly Chel