Metadata-Version: 2.4
Name: sshoc
Version: 0.1.0
Summary: Lightweight SSH toolkit with optional MCP(stdio) JSON-RPC adapter
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship, whether in Source or
              Object form, made available under the License, as indicated by a
              copyright notice that is included in or attached to the work
              (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other modifications
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean any work of authorship, including
              the original version of the Work and any modifications or additions
              to that Work or Derivative Works thereof, that is intentionally
              submitted to Licensor for inclusion in the Work by the copyright owner
              or by an individual or Legal Entity authorized to submit on behalf of
              the copyright owner. For the purposes of this definition, "submitted"
              means any form of electronic, verbal, or written communication sent
              to the Licensor or its representatives, including but not limited to
              communication on electronic mailing lists, source code control systems,
              and issue tracking systems that are managed by, or on behalf of, the
              Licensor for the purpose of discussing and improving the Work, but
              excluding communication that is conspicuously marked or otherwise
              designated in writing by the copyright owner as "Not a Contribution."
        
              "Contributor" shall mean Licensor and any individual or Legal Entity
              on behalf of whom a Contribution has been received by Licensor and
              subsequently incorporated within the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent claims licensable
              by such Contributor that are necessarily infringed by their
              Contribution(s) alone or by combination of their Contribution(s)
              with the Work to which such Contribution(s) was submitted. If You
              institute patent litigation against any entity (including a
              cross-claim or counterclaim in a lawsuit) alleging that the Work
              or a Contribution incorporated within the Work constitutes direct
              or contributory patent infringement, then any patent licenses
              granted to You under this License for that Work shall terminate
              as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or
                  Derivative Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, then any Derivative Works that You distribute must
                  include a readable copy of the attribution notices contained
                  within such NOTICE file, excluding those notices that do not
                  pertain to any part of the Derivative Works, in at least one
                  of the following places: within a NOTICE text file distributed
                  as part of the Derivative Works; within the Source form or
                  documentation, if provided along with the Derivative Works; or,
                  within a display generated by the Derivative Works, if and
                  wherever such third-party notices normally appear. The contents
                  of the NOTICE file are for informational purposes only and
                  do not modify the License. You may add Your own attribution
                  notices within Derivative Works that You distribute, alongside
                  or as an addendum to the NOTICE text from the Work, provided
                  that such additional attribution notices cannot be construed
                  as modifying the License.
        
              You may add Your own copyright statement to Your modifications and
              may provide additional or different license terms and conditions
              for use, reproduction, or distribution of Your modifications, or
              for any such Derivative Works as a whole, provided Your use,
              reproduction, and distribution of the Work otherwise complies with
              the conditions stated in this License.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or redistributing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or consequential damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or any and all
              other commercial damages or losses), even if such Contributor
              has been advised of the possibility of such damages.
        
           9. Accepting Warranty or Additional Liability. While redistributing
              the Work or Derivative Works thereof, You may choose to offer,
              and charge a fee for, acceptance of support, warranty, indemnity,
              or other liability obligations and/or rights consistent with this
              License. However, in accepting such obligations, You may act only
              on Your own behalf and on Your sole responsibility, not on behalf
              of any other Contributor, and only if You agree to indemnify,
              defend, and hold each Contributor harmless for any liability
              incurred by, or claims asserted against, such Contributor by reason
              of your accepting any such warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           APPENDIX: How to apply the Apache License to your work.
        
              To apply the Apache License to your work, attach the following
              boilerplate notice, with the fields enclosed by brackets "[]"
              replaced with your own identifying information. (Don't include
              the brackets!)  The text should be enclosed in the appropriate
              comment syntax for the file format. We also recommend that a
              file or class name and description of purpose be included on the
              same "printed page" as the copyright notice for easier
              identification within third-party archives.
        
           Copyright [yyyy] [name of copyright owner]
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.10
Requires-Dist: paramiko>=3.4.0
Description-Content-Type: text/markdown

# SSHOC

一个轻量、配置驱动的 SSH 工具集合（CLI + 可选 MCP stdio 适配）：用 `json` 配置多台服务器，然后通过：

- **CLI 前缀命令**：`sshoc <profile>: <command...>`（快速执行远端命令）
- **MCP(stdio) 服务**：对外暴露 `tools/list` / `tools/call`，让支持 MCP 的客户端直接调用 `ssh.run` / `ssh.upload` / `ssh.download`

---

## 快速上手（pip 用户）

1) 安装：

```bash
python -m pip install -U sshoc
```

2) 初始化配置（写入用户配置目录，推荐）：

```bash
# Password auth（推荐用环境变量保存密码）
sshoc init demo --ssh "ssh -p 22 user@host" --password-env SSHOC_DEMO_PASSWORD

# 或 Key auth
sshoc init demo --ssh "ssh -p 22 user@host" --key-path ~/.ssh/id_ed25519
```

3) 设置密码环境变量（仅 password_env 方式需要）：

```powershell
$env:SSHOC_DEMO_PASSWORD="your_password"
```

```bash
export SSHOC_DEMO_PASSWORD="your_password"
```

4) 使用：

```bash
sshoc list
sshoc demo: uname -a
```

---

## 安装

### 方式 A：从 PyPI 安装（推荐）

```bash
python -m pip install -U sshoc
```

### 方式 B：从源码安装（开发）

建议在本目录单独建虚拟环境（也可用你习惯的方式）：

```bash
cd "SSH_Operation_Component (MCP)"
python -m venv .venv
.venv\\Scripts\\activate
python -m pip install -U pip
python -m pip install -e .
```

> 依赖：`paramiko`（SSH/SFTP）。

---

## 配置

### 1) 生成配置（`sshoc init`）

```bash
# 写入到用户配置目录（推荐）
sshoc init

# 或写入到当前目录 ./sshoc.config.json
sshoc init --local

# 或写入到任意路径
sshoc init --output /path/to/sshoc.config.json
```

说明：

- `sshoc init`（无 `<profile>`）会写入**完整模板**（包含 demo profile）。
- `sshoc init <profile> --ssh ... --password-env/--password/--key-path ...` 会写入**单 profile 配置**（更适合 pip 用户快速上手）。

### 2) 配置文件在哪里？（以及我现在用的是哪一份？）

用这条命令查看当前会读取哪份配置：

```bash
sshoc config path
```

它会输出：

- `path`：配置文件路径
- `source`：来源（`cli|env|cwd|user|package`）
- `exists`：该路径是否存在

用户配置目录默认位置：

- Windows：`%APPDATA%\\sshoc\\sshoc.config.json`
- macOS：`~/Library/Application Support/sshoc/sshoc.config.json`
- Linux：`~/.config/sshoc/sshoc.config.json`（或 `$XDG_CONFIG_HOME/sshoc/sshoc.config.json`）

### 3) 工程化建议：用 `SSHOC_CONFIG` 固定配置路径

如果你希望“在任何目录运行都读取同一份配置”，建议设置环境变量 `SSHOC_CONFIG`：

```powershell
$env:SSHOC_CONFIG="C:\\path\\to\\sshoc.config.json"
```

```bash
export SSHOC_CONFIG="/path/to/sshoc.config.json"
```

### 4)（可选）在仓库里开发：复制模板文件

如果你是在仓库里开发，也可以直接把模板复制为 `sshoc.config.json`（模板包含 `$schema` 指向 `sshoc.config.schema.json`，方便 IDE 做字段提示；解析时也允许该字段存在）：

```bash
# macOS / Linux
cp sshoc.config.template.json sshoc.config.json
```

```powershell
# Windows PowerShell / CMD
copy sshoc.config.template.json sshoc.config.json
# 或：
Copy-Item sshoc.config.template.json sshoc.config.json
```

然后设置密码（推荐用环境变量，避免把密码明文写进 git）：

```powershell
$env:SSHOC_DEMO_PASSWORD="your_password"
```

### 配置字段要点

- `servers.<profile>`：你自定义的 profile 名称（建议 `a-zA-Z0-9_-`）
- `servers.<profile>.ssh_command`：支持常见形式 `ssh -p <port> user@host`（高级 ssh 参数请改用显式字段/功能扩展）
- `auth.type`：
  - `password`：支持 `password` 或 `password_env`
  - `key`：支持 `private_key_path`（可选 `private_key_passphrase_env`）
- `known_hosts_policy`：
  - `strict`：默认，未知 host key 直接报错（更安全）
  - `accept_new`：首次连接自动写入 `known_hosts_path`
- `default_shell`：可选，常用 `bash -lc`（更接近交互环境）；若远端无 bash 可设为 `null`

---

## CLI 使用（前缀命令）

列出配置里的所有 profile：

```bash
sshoc list
```

### Profile 管理（编辑配置文件）

> 这些命令会直接修改当前生效的配置文件。建议先用 `sshoc config path` 确认路径；也可以通过 `--config <path>` 显式指定。

```bash
# 删除某个 profile
sshoc profile remove demo

# 清空所有 profiles（把 servers 置为空对象）
sshoc profile clear
```

执行远端命令（推荐的“前缀”形式）：

```bash
sshoc demo: uname -a
sshoc demo: "ls -la /root"
```

显式子命令形式（便于参数化）：

```bash
sshoc run demo --cmd "python -V"
sshoc upload demo --local ./local.txt --remote /tmp/local.txt --overwrite
sshoc download demo --remote /tmp/local.txt --local ./downloaded.txt --overwrite
```

默认配置文件查找顺序：

1. `--config <path>`
2. 环境变量 `SSHOC_CONFIG`
3. 当前目录 `./sshoc.config.json`
4. 用户配置目录（Windows: `%APPDATA%\\sshoc\\sshoc.config.json`；Linux: `~/.config/sshoc/sshoc.config.json`）
5. 包/源码目录内 `sshoc.config.json`（开发兜底）

---

## MCP(stdio) server 使用

启动：

```bash
sshoc-mcp
```

它会在 `stdin/stdout` 上用**按行 JSON**的方式收发 JSON-RPC（对齐 MCP 的 stdio transport 习惯）。

提供的工具：

- `ssh.list_profiles`
- `ssh.run`
- `ssh.upload`
- `ssh.download`

---

## 安全提示（强烈建议）

- 不要把云服务器密码明文提交到仓库。优先使用 `password_env`。
- 这个组件等价于“给 AI 一个远程执行入口”，请只在你信任的环境里使用。

---

## License

Apache-2.0（见 `LICENSE`）。
