Merge pull request #5 from minchodang/develop

minchodang · web-flow · commit 2294261f12b4 · 2025-09-07T13:57:27.000+09:00
Feat: pacakge setup and etc settings
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -0,0 +1,18 @@
+# Global code owners
+* @minchodang
+
+# CLI package specific
+/packages/cli/ @minchodang
+
+# GitHub Actions and CI/CD
+/.github/ @minchodang
+
+# Documentation
+/README.md @minchodang
+/packages/cli/README.md @minchodang
+
+# Package configuration
+/package.json @minchodang
+/packages/cli/package.json @minchodang
+/pnpm-workspace.yaml @minchodang
+/turbo.json @minchodang
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -7,6 +7,11 @@ on:
 
 concurrency: ${{ github.workflow }}-${{ github.ref }}
 
+permissions:
+    contents: write
+    pull-requests: write
+    packages: write
+
 jobs:
     release:
         name: Release
@@ -52,6 +57,7 @@ jobs:
                   publish: pnpm release
                   title: 'chore: release packages'
                   commit: 'chore: release packages'
+                  createGithubReleases: true
               env:
                   GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
                   NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 simple-remote-ssh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -1,85 +1,113 @@
-# Turborepo starter
+# Simple Remote SSH
 
-This is an official starter Turborepo.
+🚀 **A simple and convenient SSH connection management tool**
 
-## Using this example
+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.
 
-Run the following command:
+## ✨ Features
 
-```sh
-npx create-turbo@latest
+-   🔗 **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
+
+```bash
+# 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
 ```
 
-## What's inside?
+## 🚀 Quick Start
+
+```bash
+# Add your first SSH host
+simple-ssh add
 
-This Turborepo includes the following packages/apps:
+# List all saved hosts
+simple-ssh list
 
-### Apps and Packages
+# Connect to a host (interactive selection)
+simple-ssh
 
-- `docs`: a [Next.js](https://nextjs.org/) app
-- `web`: another [Next.js](https://nextjs.org/) app
-- `@repo/ui`: a stub React component library shared by both `web` and `docs` applications
-- `@repo/eslint-config`: `eslint` configurations (includes `eslint-config-next` and `eslint-config-prettier`)
-- `@repo/typescript-config`: `tsconfig.json`s used throughout the monorepo
+# Connect to specific host
+simple-ssh connect my-server
+```
 
-Each package/app is 100% [TypeScript](https://www.typescriptlang.org/).
+## 📖 Documentation
 
-### Utilities
+For detailed usage instructions, examples, and API reference, see the [CLI package documentation](./packages/cli/README.md).
 
-This Turborepo has some additional tools already setup for you:
+## 🏗️ Project Structure
 
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
+This is a monorepo built with [Turborepo](https://turbo.build/) containing:
 
-### Build
+### Packages
 
-To build all apps and packages, run the following command:
+-   **`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
 
-```
-cd my-turborepo
-pnpm build
-```
+### Apps
 
-### Develop
+-   **`apps/docs`** - Documentation website (planned)
+-   **`apps/web`** - Web interface (planned)
 
-To develop all apps and packages, run the following command:
+## 🛠️ Development
 
-```
-cd my-turborepo
+```bash
+# Install dependencies
+pnpm install
+
+# Build all packages
+pnpm build
+
+# Develop with watch mode
 pnpm dev
+
+# Run tests
+pnpm test
+
+# Lint code
+pnpm lint
 ```
 
-### Remote Caching
+## 🤝 Contributing
 
-> [!TIP]
-> Vercel Remote Cache is free for all plans. Get started today at [vercel.com](https://vercel.com/signup?/signup?utm_source=remote-cache-sdk&utm_campaign=free_remote_cache).
+Contributions are welcome! Please feel free to submit a Pull Request.
 
-Turborepo can use a technique known as [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching) to share cache artifacts across machines, enabling you to share build caches with your team and CI/CD pipelines.
+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
 
-By default, Turborepo will cache locally. To enable Remote Caching you will need an account with Vercel. If you don't have an account you can [create one](https://vercel.com/signup?utm_source=turborepo-examples), then enter the following commands:
+## 📄 License
 
-```
-cd my-turborepo
-npx turbo login
-```
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
 
-This will authenticate the Turborepo CLI with your [Vercel account](https://vercel.com/docs/concepts/personal-accounts/overview).
+## 👤 Author
 
-Next, you can link your Turborepo to your Remote Cache by running the following command from the root of your Turborepo:
+**minchodang** <minsu910725@gmail.com>
 
-```
-npx turbo link
-```
+-   GitHub: [@minchodang](https://github.com/minchodang)
+
+## 🔗 Links
 
-## Useful Links
+-   [npm package](https://www.npmjs.com/package/simple-remote-ssh)
+-   [GitHub Repository](https://github.com/kangminsu/simple_remote_ssh)
+-   [Issue Tracker](https://github.com/kangminsu/simple_remote_ssh/issues)
 
-Learn more about the power of Turborepo:
+---
 
-- [Tasks](https://turbo.build/repo/docs/core-concepts/monorepos/running-tasks)
-- [Caching](https://turbo.build/repo/docs/core-concepts/caching)
-- [Remote Caching](https://turbo.build/repo/docs/core-concepts/remote-caching)
-- [Filtering](https://turbo.build/repo/docs/core-concepts/monorepos/filtering)
-- [Configuration Options](https://turbo.build/repo/docs/reference/configuration)
-- [CLI Usage](https://turbo.build/repo/docs/reference/command-line-reference)
-# my-turbo-repo-template
+⭐ **Star this repository if you find it helpful!**
diff --git a/packages/cli/CHANGELOG.md b/packages/cli/CHANGELOG.md
@@ -0,0 +1,48 @@
+# simple-remote-ssh
+
+## 0.1.1
+
+### Patch Changes
+
+- e499e1f: # 🎉 Simple Remote SSH v0.1.0 - Initial Release
+
+  ## ✨ Key Features
+
+  ### SSH Host Management
+
+  - **Add Host**: `simple-ssh add` - Interactive host information input
+  - **List Hosts**: `simple-ssh list` - View saved host list
+  - **Edit Host**: `simple-ssh edit <hostname>` - Modify host information
+  - **Remove Host**: `simple-ssh remove <hostname>` - Delete host
+
+  ### SSH Connection
+
+  - **Interactive Connection**: `simple-ssh` - Select and connect to host
+  - **Direct Connection**: `simple-ssh connect <hostname>` - Connect directly to specific host
+  - **Connection Options**: Username and port override support
+
+  ### Authentication Methods
+
+  - **SSH Key File**: Secure key-based authentication
+  - **Password**: Interactive password input on connection
+  - **Default SSH Settings**: Use system default SSH configuration
+
+  ### Additional Features
+
+  - **Tag System**: Host categorization and management
+  - **Description Field**: Per-host notes
+  - **Colorful UI**: Intuitive user interface
+
+  ## 🚀 Installation & Usage
+
+  ```bash
+  # Global installation
+  npm install -g simple-remote-ssh
+
+  # Usage
+  simple-ssh --help
+  ```
+
+  ## 💾 Configuration File
+
+  Host information is securely stored in `~/.ssh-easy/config.json`.
diff --git a/packages/cli/LICENSE b/packages/cli/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 simple-remote-ssh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/packages/cli/README.md b/packages/cli/README.md
diff --git a/packages/cli/package.json b/packages/cli/package.json
