ipster

README

ipster

ipster is a CLI application that stores IP addresses and their associated details in the terminal for quick access. It allows you to easily add, list, remove, and generate SSH commands for saved IP addresses.

Installation

To install IPster, you can use go install. Make sure you have Go installed on your system before proceeding with the installation.

go install github.com/charlesdevelops/ipster@latest

Usage

The basic usage of ipster is as follows:

ipster [command]

Available Commands

• add: Add an IP address
• completion: Generate the autocompletion script for the specified shell
• help: Help about any command
• ls: List all saved addresses
• rm: Remove entries from the application
• ssh: Generates an SSH command to a saved IP address

You can use the --help flag with any command to get more information about it. For example:

ipster add --help

Examples

• Add an IP address:

  ipster add <IP address> -d <description> -k <key location>
  

• List all saved addresses:

  ipster ls
  

• Remove entries from the application:

  ipster rm <entry id>
  

• Generate an SSH command for a saved IP address:

  ipster ssh <entry id>
  

We can add an address and connect to it as such:

Note that the pictured server, IP address, key, and all related details in these screenshots were deleted and / or decommissioned as appropriate.

Dependencies

ipster depends on the following libraries:

• sqlite3
• cobra by spf13 (the framework used to build the CLI app)
• github.com/atotto/clipboard (for copying strings to the clipboard from the SSH command)
• modernc.org/sqlite (for the non-cgo SQLite3 driver)

Acknowledgements

ipster was written in Go. Many thanks to the following projects and their contributors for their work:

• sqlite3
• cobra by spf13
• github.com/atotto/clipboard
• modernc.org/sqlite
• Go

License

This project is licensed under the Apache License Version 2.0.

---

Thank you for using ipster! If you encounter any issues or have suggestions for improvements, please open an issue on the GitHub repository.

Documentation

Overview

Copyright © 2023 CHARLES WATSON