swan-ssh 1.1.0

A CLI tool to manage and sync SSH connections via Git

Swan SSH 🦢

A simple, fast, and beautiful CLI tool to manage and synchronize SSH connections seamlessly across all your devices using a private Git repository. Made with Python, Typer, and Rich.

Installation

The recommended way to install Swan SSH is via pipx. This ensures it's installed in an isolated environment without disturbing your system's Python packages.

pipx install swan-ssh

⚠️ Important Note on pipx PATH: If you see a warning saying ~/.local/bin is not on your PATH, you simply need to run:

pipx ensurepath

Then close and reopen your terminal. Your swan command will now be globally available!

Usage Flow

1. Initialize the workspace: First, create a private GitHub repository. Then, run swan init and paste its URL.

   swan init
   

2. Add a Server:

   swan add
   # Prompts for label, ip, port, username, password
   # Automatically commits and pushes to your private repo behind the scenes!
   

3. List Servers: Brings up a beautiful formatting table of your servers.

   swan list
   

4. Connect Instantly: Using the short ID from the list command.

   swan connect <id>
   

5. Transfer Files (Copy): Transfer files or directories to and from a server using its short ID.

   # Upload a local file to the server
   swan copy <id> /local/path /remote/path
   
   # Download a file from the server (-d flag)
   swan copy <id> /local/path /remote/path -d
   
   # Copy directories recursively with a progress bar (-r -p)
   swan copy <id> /local/dir /remote/dir -r -p
   

6. Sync from Another Device: Installed Swan on your Macbook? Just run:

   swan init
   # Provide the same repo URL
   swan sync
   # Ready to connect!
   

7. Remove a Server:

   swan rm <id>
   

8. Clean up & Uninstall: If you ever want to completely remove the configuration directory (~/.swan-ssh) before uninstalling the tool, use:

   swan destroy
   pipx uninstall swan-ssh