Skip to content

README.md

Latest commit

 

History

History
113 lines (74 loc) · 2.85 KB

README.md

File metadata and controls

113 lines (74 loc) · 2.85 KB

Simple Remote SSH

🚀 A simple and convenient SSH connection management tool

Easily manage and connect to your SSH hosts with an intuitive CLI interface. Store host configurations, manage authentication methods, and execute commands automatically upon connection.

✨ Features

  • 🔗 Easy Connection: Connect to saved hosts with a single command
  • 📋 Host Management: Add, edit, and delete SSH hosts interactively
  • 🎯 Interactive Interface: Intuitive host selection with prompts
  • 🔑 Multiple Auth Methods: SSH keys, password, or default SSH settings
  • 🤖 Auto Commands: Execute commands automatically on connection
  • 🏷️ Tag System: Organize hosts with custom tags
  • ⚡ Quick Access: Short and memorable commands

📦 Installation

# Install globally from npm
npm install -g simple-remote-ssh

# Or using yarn
yarn global add simple-remote-ssh

# Or using pnpm
pnpm add -g simple-remote-ssh

🚀 Quick Start

# Add your first SSH host
simple-ssh add

# List all saved hosts
simple-ssh list

# Connect to a host (interactive selection)
simple-ssh

# Connect to specific host
simple-ssh connect my-server

📖 Documentation

For detailed usage instructions, examples, and API reference, see the CLI package documentation.

🏗️ Project Structure

This is a monorepo built with Turborepo containing:

Packages

  • packages/cli - The main CLI tool for SSH connection management
  • packages/ui - Shared UI components (for future extensions)
  • packages/eslint-config - Shared ESLint configurations
  • packages/typescript-config - Shared TypeScript configurations

Apps

  • apps/docs - Documentation website (planned)
  • apps/web - Web interface (planned)

🛠️ Development

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Develop with watch mode
pnpm dev

# Run tests
pnpm test

# Lint code
pnpm lint

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

  1. Fork the repository
  2. Create your feature branch (git checkout -b feature/amazing-feature)
  3. Commit your changes (git commit -m 'Add some amazing feature')
  4. Push to the branch (git push origin feature/amazing-feature)
  5. Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

👤 Author

minchodang minsu910725@gmail.com

🔗 Links

⭐ Star this repository if you find it helpful!