| name | ssh-api-setup |
| description | Use this skill when you need to install, configure, start, verify, or hand off SSH ~ Api to another agent. It covers local bootstrap, config creation, startup, OpenAPI discovery, and the correct workflow for using the API against a Linux VPS. |
SSH ~ Api Setup Skill
Repository:
https://github.com/vibheksoni/ssh-api
When To Use
Use this skill when:
- setting up the repository locally for the first time
- asking an agent to start the API
- handing the running API to another agent
- documenting or verifying the correct agent workflow
Do not use this skill for unrelated Python repo tasks.
Core Workflow
- Bootstrap the repository.
- Ensure
config.json exists, preferably copied from config.example.json.
- Start the API with
python run.py.
- Verify that
/docs, /redoc, and /openapi.json are reachable.
- Read
SSH_API_GUIDE.md.
- When operating the API against a remote host, create a session and store
session_id.
Preferred Commands
Windows:
powershell -ExecutionPolicy Bypass -File .\scripts\bootstrap.ps1
macOS / Linux:
./scripts/bootstrap.sh
Manual:
pip install -r requirements.txt
python run.py
Install This Skill
Public GitHub install via npx skills:
npx skills add vibheksoni/ssh-api --skill ssh-api-setup
List available skills in this repo first:
npx skills add vibheksoni/ssh-api --list
Rules
- Never commit
config.json.
- Never place real credentials in tracked files.
- Prefer the API's structured routes over inventing raw SSH workflows.
- If the API is already running, verify it instead of starting a duplicate instance.
Validation
At minimum, confirm:
- the server process started successfully
/docs is reachable/openapi.json is reachable- the next agent knows to fetch
/openapi.json and read SSH_API_GUIDE.md
