{"id":18735947,"url":"https://github.com/sub-store-org/sub-store-manager-cli","last_synced_at":"2025-04-12T19:21:37.039Z","repository":{"id":191161388,"uuid":"684049275","full_name":"sub-store-org/Sub-Store-Manager-Cli","owner":"sub-store-org","description":"A cli tool for https://github.com/sub-store-org/Sub-Store base docker.","archived":false,"fork":false,"pushed_at":"2024-04-29T09:36:03.000Z","size":64,"stargazers_count":130,"open_issues_count":2,"forks_count":14,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-26T13:38:23.212Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sub-store-org.png","metadata":{"files":{"readme":"README-CN.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"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-08-28T10:53:17.000Z","updated_at":"2025-03-23T11:49:08.000Z","dependencies_parsed_at":"2023-08-28T13:13:26.666Z","dependency_job_id":"2becf60a-4c5a-4da2-89a8-cef4358035ac","html_url":"https://github.com/sub-store-org/Sub-Store-Manager-Cli","commit_stats":null,"previous_names":["desnlee/sub-store-manager-cli","sub-store-org/sub-store-manager-cli"],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sub-store-org%2FSub-Store-Manager-Cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sub-store-org%2FSub-Store-Manager-Cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sub-store-org%2FSub-Store-Manager-Cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sub-store-org%2FSub-Store-Manager-Cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sub-store-org","download_url":"https://codeload.github.com/sub-store-org/Sub-Store-Manager-Cli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618699,"owners_count":21134284,"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":[],"created_at":"2024-11-07T15:18:47.828Z","updated_at":"2025-04-12T19:21:36.970Z","avatar_url":"https://github.com/sub-store-org.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Sub-Store-Manager-Cli\n\n[English](./README.md) | 简体中文\n\n用于管理 [Sub-Store](https://github.com/sub-store-org/Sub-Store) 后端服务的命令行工具。由于该工具基于 [Docker](https://www.docker.com/)，您需要先安装 Docker。\n\n\n# 安装\n\n您可以通过运行以下命令来安装这个工具：\n\n```bash\ncurl -sSL https://sub-store-org.github.io/resource/ssm/install.sh | bash\n```\n\n或者您可以下载 [Release 文件](https://github.com/DesnLee/Sub-Store-Manager-Cli/releases)，并手动配置环境变量和程序名称。\n\n\n# 使用方法\n\n如果您正在使用脚本安装则可以直接执行以下命令。如果您正在进行手动安装，请确保每个命令中的程序名称匹配你的可执行文件名。\n\n### new\n\n创建一个新的 Sub-Store Docker 容器并运行，如果镜像不存在将自动构建。\n\n```bash\nssm new\n```\n\n该命令支持以下 `flag`：\n\n- `--interface` 或 `-i` ：当您传递 `-i` 标志时，将创建前端容器而不是后端容器。默认行为是创建一个后端容器。\n \n- `--name` 或 `-n` ：容器的唯一名称，默认名称为 `ssm-backend`，如果您传递了 `-i` 标标志来创建一个前端容器，则默认名称为 `ssm-frontend`。此名称将用于管理持久化数据，只要不手动删除该名称的持久化数据，或者使用 `ssm delete -c` 标志执行删除操作，无论是如何删除/重建容器，只要使用此名称都可以访问该数据。\n\n- `--version` 或 `-v` ：一个 [Sub-Store Release](https://github.com/sub-store-org/Sub-Store/releases) 的版本字符串，默认获取最新版本。如果您传递了 `-i` 标志来创建前端容器，则 `-v` 标志将被忽略，它总是使用最新版本的前端。\n\n- `--port` 或 `-p` ：指定端口映射，默认为 `3000`，且必须可用，如果您传递了 `-i` 标标志来创建一个前端容器，则默认端口为 `80`。如果你想使用域名访问服务，则需要使用反向代理工具（如 Nginx 或 Caddy）手动代理该端口。\n\n- `--network` ：指定一个 docker network，作用等同于 `docker run` 中的 `--network`, 不指定使用 Host 模式，指定则使用 Bridge 模式，若网络存在则加入该网络，若不存在则创建该网络并加入。\n\n- `--private` ：切换容器的 HostIP 为 `127.0.0.1`, 如不指定则使用默认的 `0.0.0.0`。\n\n\n### update\n\n更新一个 Sub-Store Docker 容器，确保镜像已经存在且正在运行。\n\n```bash\nssm update\n```\n\n该命令支持以下 `flag`：\n\n- `--name` 或 `-n` ：一个正在运行的容器名称，默认名称为 `ssm-backend`。\n\n- `--version` 或 `-v` ：一个 [Sub-Store Release](https://github.com/sub-store-org/Sub-Store/releases) 的版本字符串，默认获取最新版本。如果您更新目标为前端容器，则 `-v` 标志将被忽略，它总是使用最新版本的前端。\n\n\n### start\n\n启动一个未在运行的 Sub-Store Docker 容器，默认名称为 `ssm-backend`。\n\n\u003e 基本等价于 `docker start \u003cname\u003e`.\n\n```bash\nssm new \u003cname\u003e\n```\n\n\n### stop\n\n停止一个正在运行的 Sub-Store Docker 容器，默认名称为 `ssm-backend`。\n\n\u003e 基本等价于 `docker stop \u003cname\u003e`.\n\n```bash\nssm stop \u003cname\u003e\n```\n\n\n### delete\n\n删除一个 Sub-Store Docker 容器，默认名称为 `ssm-backend`。\n\n\u003e 基本等价于 `docker rm \u003cname\u003e`.\n\n```bash\nssm delete \u003cname\u003e\n```\n\n该命令支持以下 `flag`：\n \n- `--clear` 或 `-c` : 同时删除容器的持久化数据。如果删除的为前端镜像，则 `-c` 标志将被忽略，因为前端镜像没有持久化数据。\n\n\n### list\n\n列出所有 Sub-Store Docker 容器。\n\n\u003e 基本等价于 `docker ps -a` 并过滤以 `ssm` 镜像启动的容器。\n\n```bash\nssm ls\n```\n\n\n### version\n\n查看当前 Sub-Store-Manager-Cli 的版本。\n\n```bash\nssm version\n```\n\n\n# 卸载\n\n如果您使用脚本安装则可以直接执行以下命令。如果您使用手动安装，请手动移除您的可执行文件。\n\n```bash\nrm -rf /usr/local/bin/ssm\n```\n\n如果您想同时删除持久化数据，可以执行以下命令：\n\n```bash\nrm -rf ~/.ssm\n```\n\n\n# License\nGPL-3.0 License\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsub-store-org%2Fsub-store-manager-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsub-store-org%2Fsub-store-manager-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsub-store-org%2Fsub-store-manager-cli/lists"}