README
¶
Install
curl -fsSL https://raw.githubusercontent.com/PaperValet/PaperValet/master/scripts/install.sh | bash
papervalet initialize
initialize walks you through language, API credentials, login, a companion bot and an optional systemd service. Get api_id / api_hash at my.telegram.org and a bot token from @BotFather. Then send .ping in any chat.
Docker, upgrades and troubleshooting: Installation.
Commands
Everything is triggered by your own messages. .help lists all commands, .help <command> explains one.
Settings are not commands. Language, prefixes, sudo, log level and every plugin's options live in the companion bot: send it /menu and tap. It has three panels: system settings, external plugin settings, and a plugin manager that installs, removes and reloads plugins from the repository.
| Plugin | Command | What it does |
|---|---|---|
| ping | .ping [host], .pingdc |
Latency to Telegram, a host, or every DC |
| status | .status |
Version, host, resources, runtime |
| info | .info |
User, chat and message details |
| dc | .dc [@user|ID] |
Data center of a user, group or channel |
| re | .re [count] [times] |
Repeat the replied message |
| dme | .dme <n|all> [-f] |
Delete your recent messages |
| exec | .exec <cmd> |
Run a shell command |
| apt | .apt s / i / rm / ls / info |
Install and remove external plugins |
| reload | .reload |
Reload external plugins |
| restart | .restart |
Restart in place |
| update | .update [now|-f] |
Upgrade from GitHub Releases |
| backup | .backup [restore] |
Back up config to Saved Messages |
| sudo | .sudo add / remove |
Let other users run commands |
| alias | .alias name=command |
Your own shortcuts |
| log | .sendlog [tail|clean] |
Log files |
Plugins
External plugins come from PaperValet-Plugins:
.apt s browse
.apt i weather install one
.apt i -all install everything
Reply to a plugin .so file with .apt i (or send it to the companion
bot) to install straight from the file; it lands under the plugin's own
module name.
To write one, see the Plugin SDK.
Development
make build # ./papervalet
make test
make lint
Go 1.25. External plugins must be built with the same Go version and -trimpath as the binary.
License
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
papervalet
command
|
|
|
internal
|
|
|
bot
Package bot runs the companion Telegram bot.
|
Package bot runs the companion Telegram bot. |
|
i18n
Package i18n provides native multi-language support for PaperValet.
|
Package i18n provides native multi-language support for PaperValet. |
|
settings
Package settings stores plugin options declared with plugin.SettingsSpec.
|
Package settings stores plugin options declared with plugin.SettingsSpec. |
|
setup
Package setup implements the interactive `initialize` subcommand: language, API credentials, Telegram login and optional system service registration.
|
Package setup implements the interactive `initialize` subcommand: language, API credentials, Telegram login and optional system service registration. |
|
pkg
|
|
|
plugin
Package plugin provides the public SDK for PaperValet plugins.
|
Package plugin provides the public SDK for PaperValet plugins. |
|
plugins
|
|