{"id":22234638,"url":"https://github.com/athphane/sshmenu","last_synced_at":"2025-07-20T02:37:08.743Z","repository":{"id":177689402,"uuid":"658123612","full_name":"athphane/sshmenu","owner":"athphane","description":"A CLI app to easily manage and connect to your SSH hosts from one simple menu","archived":false,"fork":false,"pushed_at":"2023-10-28T17:58:05.000Z","size":62,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-07T07:39:44.117Z","etag":null,"topics":["management","putty","python","ssh","ssh-client"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/athphane.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-06-24T20:59:55.000Z","updated_at":"2024-03-20T19:35:33.000Z","dependencies_parsed_at":null,"dependency_job_id":"4b43eeb6-60b0-43f4-9b99-481b90df91fb","html_url":"https://github.com/athphane/sshmenu","commit_stats":null,"previous_names":["athphane/sshmenu"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/athphane/sshmenu","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athphane%2Fsshmenu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athphane%2Fsshmenu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athphane%2Fsshmenu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athphane%2Fsshmenu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/athphane","download_url":"https://codeload.github.com/athphane/sshmenu/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/athphane%2Fsshmenu/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266058481,"owners_count":23870157,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["management","putty","python","ssh","ssh-client"],"created_at":"2024-12-03T02:09:11.184Z","updated_at":"2025-07-20T02:37:08.708Z","avatar_url":"https://github.com/athphane.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# SSHMenu\n\n![sshmenu screenshot](assets/screenshot.png)\n\nSSHMenu is a command-line tool that allows you to manage and connect to your SSH hosts conveniently. You can\nadd new hosts, toggle address visibility, and select hosts to establish SSH connections.\n\n## Features\n\n- Add new SSH hosts by providing the name, username, address, and port.\n- Toggle address visibility to obfuscate or reveal the host addresses.\n- Select a host from the list to establish an SSH connection.\n\n## Prerequisites\n\n- Python 3.x\n- pip package manager\n\n## Installation\n\n1. Clone the repository:\n\n```shell\ngit clone https://github.com/athphane/sshmenu.git\n```\n\n2. Navigate to the project directory\n\n```shell\ncd sshmenu\n```\n\n3. Install the required dependencies\n\n```shell\npip install -r requirements.txt\n```\n\n## Usage\n\nTo run the SSH Host Management tool, use the following command:\n\n```shell\npython main.py [--add] [--toggle] [--filter TAG]\n```\n\n- `--add`: Add a new host interactively.\n- `--toggle`: Toggle address visibility for a host.\n- `--filter TAG`: Filter hosts by the specified tag.\n\nNote: If no options are provided, the tool will display a list of hosts for selection.\n\n## The hosts.json file\n\nThe script will look for the hosts.json file in a \"sensible default\" location, which is the user's SSH config folder.\nHere's the full path to it: `~/.ssh/hosts.json`\n\n## Configuration\n\nThe hosts are stored in a JSON file named `hosts.json`. You can manually edit this file to add or modify hosts.\n\nEach host object should have the following attributes:\n\n- `name`: The name of the host.\n- `username`: The SSH username for the host.\n- `address`: The IP address or hostname of the host.\n- `port`: The SSH port number for the host.\n- `tags` (optional): A list of tags associated with the host.\n\nHere's an example of the JSON structure:\n\n```json\n{\n  \"hosts\": [\n    {\n      \"name\": \"Example Host\",\n      \"username\": \"user\",\n      \"address\": \"192.168.0.1\",\n      \"port\": 22,\n      \"tags\": [\n        \"tag1\",\n        \"tag2\"\n      ]\n    },\n    ...\n  ]\n}\n```\n\n## Examples\n\n1. Add a new host:\n\n```shell\npython main.py --add\n```\n\n2. Toggle address visibility for a host\n\n```shell\npython main.py --toggle\n```\n\n3. Filter hosts by a tag\n\n```shell\npython main.py --filter tag1\n```\n\n## Building the Executable with PyInstaller\n\nPyInstaller is a popular tool for creating standalone executables from Python applications.\nFollow the steps below to build the executable for SSHMenu.\n\n1. Run the helper script to do it automatically\n\n```shell\n.\\build.bat\n```\n\nThis will run the script, activate your virtual environment and compiles an EXE of SSHMenu.\n\nThe compiled EXE will be in the [/dist](dist) folder of the project. You can move it to a different folder in your\nsystem, or to a folder that is added to your PATH, which will let you use the exe from anywhere on your system.\n\n## Contributing\n\nContributions are welcome! If you find any issues or have suggestions for improvements, feel free to open an issue or\nsubmit a pull request.\n\n## Credits\n\n- [Athfan Khaleel](https://github.com/athphane)\n- [All Contributors](../../contributors)\n\n## License\n\nThis project is licensed under the MIT License","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathphane%2Fsshmenu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fathphane%2Fsshmenu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fathphane%2Fsshmenu/lists"}