lain-shorten 1.18

A simple CLI URL shortener using s.lain.la API, with optional clipboard copy.

lain-shorten

A simple CLI URL shortener using s.lain.la API, with optional clipboard copy.

Installation

Via PyPI (Recommended)

You have the option to choose between the standard version (lain-shorten) or the desktop version (lain-shorten[clipboard]), which adds clipboard support for auto-copying links.

[!NOTE] For brevity, the examples below use the desktop version.

With pip (Basic)

pip install "lain-shorten[clipboard]"

With pipx (Isolated)

pipx install "lain-shorten[clipboard]"

With uv (Best)

The most efficient way to install or run the shortener.

# Permanent isolated installation
uv tool install "lain-shorten[clipboard]"

# Run once without installing
uvx --with "lain-shorten[clipboard]" lain-shorten <url1> <url2> <url3>

# Run in scripts or ad-hoc environments
uv run --with "lain-shorten[clipboard]" lain-shorten <url1> <url2> <url3>

From Source (Development)

# Clone the repository and navigate to it
git clone [e-mail]:NecRaul/lain-shorten.git
cd lain-shorten

# Install environment and all development dependencies (mandatory and optional)
uv sync --dev

# Install pre-commit hook
uv run pre-commit install

# Optional: Run all linters and type checkers manually
uv run pre-commit run --all-files

# Run the local version
uv run lain-shorten <url1> <url2> <url3>

# Run tests
uv run pytest tests

Usage

Simply provide a URL, and the tool will automatically handle protocol validation and formatting.

Use --open to open each generated short URL in your default browser right after shortening. This makes it easy to verify each format resolves as expected in a real browser session.

# Shorten a URL
lain-shorten https://kuroneko.dev

# Protocol-less (automatically prepends http://)
lain-shorten kuroneko.dev

# irc
lain-shorten irc://irc.libera.chat/#archlinux

# ssh
lain-shorten ssh://[e-mail]

# mailto
lain-shorten mailto:[e-mail]

# sms
lain-shorten sms:[phone]

# magnet torrent
lain-shorten "magnet:?xt=urn:btih:0123456789abcdef0123456789abcdef01234567&dn=Example"

# Open shortened URLs using the default browser
lain-shorten --open \
http://kuroneko.dev \
ircs://irc.libera.chat:6697/#archlinux \
xmpp:[e-mail] \
tel:[phone]

# Display help and version
lain-upload -h
lain-upload -v

Supported Schemes

• http:// and https:// links
• protocol-less domains (automatically normalized to http://)
• irc:// and ircs:// links
• ssh:// links
• mailto:// and xmpp:// links
• sms:// and tel:// links
• magnet: torrent links

Dependencies

• requests: send the API request for shortening.

Optional

• pyperclip: copy the shortened URLs to the clipboard.

How it works

The s.lain.la service allows shortening URLs via a POST request.

This tool automates the process to avoid typing long curl strings.

The Manual Way

curl -d "url=https://kuroneko.dev" https://s.lain.la

The lain-shorten way

• Batch Processing: Shorten multiple URLs in a single command execution, saving time over individual manual requests.
• Validation: Uses urllib to ensure the URL is formatted correctly.
• API Request: Sends the POST request via requests.
• Normalization: Automatically adds http:// if missing.
• Clipboard (Optional): If pyperclip is installed, the result is instantly copied to your clipboard.

Special thanks

• To 7666 of https://lain.la/ for running the shortener service that inspired this project.