sealos-cli 1.0.0 → 1.1.1

package/README.md

@@ -1,6 +1,6 @@
 # Sealos CLI
 
-Official CLI tool for Sealos Cloud - Manage devbox, applications, databases, and object storage
+Official CLI tool for Sealos Cloud - Manage auth, workspaces, devboxes, databases, and templates.
 
 ## Project Structure
 
@@ -18,16 +18,10 @@ src/
 │   │   └── index.ts
 │   ├── devbox/               # Devbox management
 │   │   └── index.ts
-│   ├── s3/                   # S3 object storage
-│   │   └── index.ts
 │   ├── database/             # Database management
 │   │   └── index.ts
 │   ├── template/             # Template management
 │   │   └── index.ts
-│   ├── quota/                # Resource quotas
-│   │   └── index.ts
-│   ├── app/                  # Application management
-│       └── index.ts
 ├── lib/                       # Shared libraries
 │   ├── api-client.ts         # OpenAPI client factories
 │   ├── auth.ts               # Sealos auth and kubeconfig headers
@@ -55,7 +49,7 @@ src/
 
 ### Output Formatting (`lib/output.ts`)
 
-- Support for multiple formats: JSON, YAML, Table
+- JSON and table output helpers for command responses
 - Colored terminal output using chalk
 - Loading spinners using ora
 - Table formatting using table
@@ -103,78 +97,78 @@ npm test
 
 ```bash
 # Login in browser and exchange for regional token + kubeconfig automatically
-sealos login https://usw-1.sealos.io
+sealos-cli login https://usw-1.sealos.io
 
 # Check current user
-sealos whoami
+sealos-cli whoami
 
 # Inspect auth and switch workspace
-sealos auth info
-sealos auth list
-sealos auth switch <workspace-id-or-team-name>
+sealos-cli auth info
+sealos-cli auth list
+sealos-cli auth switch <workspace-id-or-team-name>
 
 # Logout
-sealos logout
+sealos-cli logout
 ```
 
 ### Template Management
 
 ```bash
 # Deploy from the catalog
-sealos template deploy perplexica --name my-app --set OPENAI_API_KEY=xxx
+sealos-cli template deploy perplexica --name my-app --set OPENAI_API_KEY=xxx
 
 # Validate raw template YAML without creating resources
-sealos template deploy --file ./template.yaml --dry-run
+sealos-cli template deploy --file ./template.yaml --dry-run
 ```
 
 ### Workspace Management
 
 ```bash
 # List workspaces
-sealos workspace list
+sealos-cli workspace list
 
 # Switch workspace
-sealos workspace switch production
+sealos-cli workspace switch production
 
 # Show current workspace
-sealos workspace current
+sealos-cli workspace current
 ```
 
 ### Devbox Management
 
 ```bash
 # Create a devbox
-sealos devbox create --name my-devbox --runtime next.js --cpu 2c --memory 4g --port 3000:http:public
+sealos-cli devbox create --name my-devbox --runtime next.js --cpu 2c --memory 4g --port 3000:http:public
 
 # List devboxes
-sealos devbox list
-sealos devbox list --output json
+sealos-cli devbox list
+sealos-cli devbox list --output json
 
 # Get devbox details
-sealos devbox get my-devbox
+sealos-cli devbox get my-devbox
 
 # Update resources or ports
-sealos devbox update my-devbox --cpu 4 --memory 8 --port portName=web,number=3000,protocol=http,isPublic=true
+sealos-cli devbox update my-devbox --cpu 4 --memory 8 --port portName=web,number=3000,protocol=http,isPublic=true
 
 # Start/Pause/Shutdown/Restart
-sealos devbox start my-devbox
-sealos devbox pause my-devbox
-sealos devbox shutdown my-devbox
-sealos devbox restart my-devbox
+sealos-cli devbox start my-devbox
+sealos-cli devbox pause my-devbox
+sealos-cli devbox shutdown my-devbox
+sealos-cli devbox restart my-devbox
 
 # Configure autostart and inspect monitor data
-sealos devbox autostart my-devbox --exec-command "npm start"
-sealos devbox monitor my-devbox --step 2m
+sealos-cli devbox autostart my-devbox --exec-command "npm start"
+sealos-cli devbox monitor my-devbox --step 2m
 
 # Templates, releases, and deployments
-sealos devbox templates
-sealos devbox releases list my-devbox
-sealos devbox releases create my-devbox --tag v1-0-0 --description "First release"
-sealos devbox releases deploy my-devbox v1-0-0
-sealos devbox deployments my-devbox
+sealos-cli devbox templates
+sealos-cli devbox releases list my-devbox
+sealos-cli devbox releases create my-devbox --tag v1-0-0 --description "First release"
+sealos-cli devbox releases deploy my-devbox v1-0-0
+sealos-cli devbox deployments my-devbox
 
 # Delete devbox
-sealos devbox delete my-devbox
+sealos-cli devbox delete my-devbox
 ```
 
 Implementation: `src/commands/devbox/index.ts`, backed by `src/docs/devbox_openapi.json`.
@@ -183,33 +177,33 @@ Implementation: `src/commands/devbox/index.ts`, backed by `src/docs/devbox_opena
 
 ```bash
 # List databases
-sealos database list
+sealos-cli database list
 
 # Get database details
-sealos database get my-db
+sealos-cli database get my-db
 
 # Create a database
-sealos database create postgresql --name my-db --cpu 1 --memory 2 --storage 5 --replicas 1
+sealos-cli database create postgresql --name my-db --cpu 1 --memory 2 --storage 5 --replicas 1
 
 # Show connection details
-sealos database connection my-db
+sealos-cli database connection my-db
 
 # More commands
-sealos database --help
-sealos database <subcommand> --help
+sealos-cli database --help
+sealos-cli database <subcommand> --help
 
 # Operational commands backed by src/docs/database_openapi.json
-sealos database update my-db --cpu 2 --memory 4
-sealos database start my-db
-sealos database pause my-db
-sealos database restart my-db
-sealos database backup my-db --name manual-backup
-sealos database backups my-db
-sealos database restore my-db --from manual-backup --name restored-db
-sealos database enable-public my-db
-sealos database disable-public my-db
-sealos database log-files <pod-name> --db-type postgresql --log-type runtimeLog
-sealos database logs <pod-name> --db-type postgresql --log-type runtimeLog --log-path /path/to/log
+sealos-cli database update my-db --cpu 2 --memory 4
+sealos-cli database start my-db
+sealos-cli database pause my-db
+sealos-cli database restart my-db
+sealos-cli database backup my-db --name manual-backup
+sealos-cli database backups my-db
+sealos-cli database restore my-db --from manual-backup --name restored-db
+sealos-cli database enable-public my-db
+sealos-cli database disable-public my-db
+sealos-cli database log-files <pod-name> --db-type postgresql --log-type runtimeLog
+sealos-cli database logs <pod-name> --db-type postgresql --log-type runtimeLog --log-path /path/to/log
 ```
 
 Implementation: `src/commands/database/index.ts`
@@ -221,13 +215,9 @@ Implementation: `src/commands/database/index.ts`
 - `SEALOS_DEVBOX_HOST`: Override devbox provider host for devbox commands
 - `DEBUG`: Enable debug mode for verbose error output
 
-## TODO
-
-Some command implementations still contain TODO comments where API integration is needed. Key areas:
+## v1 Scope
 
-1. **S3 Operations**: File upload/download with progress tracking
-2. **Interactive Prompts**: Use inquirer for confirmations
-3. **YAML Support**: Add YAML output formatting
+The v1 command surface is limited to auth, workspace, template, database, and devbox operations. Future modules such as S3/object storage, quota inspection, and application management are intentionally not registered or documented as available commands.
 
 ## Best Practices Implemented
 
@@ -235,7 +225,7 @@ Some command implementations still contain TODO comments where API integration i
 - TypeScript for type safety
 - Shared utilities for common operations
 - Consistent error handling
-- Multiple output formats
+- JSON and table output formats
 - Environment variable support
 - Loading indicators for async operations
 - Color-coded terminal output

package/dist/bin/cli.cjs

@@ -90,7 +90,7 @@ __name(saveAuth, "saveAuth");
 function loadAuth(deps = {}) {
   const { paths } = withDeps(deps);
   if (!(0, import_node_fs.existsSync)(paths.authPath)) {
-    throw new Error("Not authenticated. Please run: sealos login");
+    throw new Error("Not authenticated. Please run: sealos-cli login");
   }
   return JSON.parse((0, import_node_fs.readFileSync)(paths.authPath, "utf-8"));
 }
@@ -112,7 +112,7 @@ __name(getAuthHeaders, "getAuthHeaders");
 function requireAuth(deps = {}) {
   const headers = getAuthHeaders(deps);
   if (!headers) {
-    throw new Error('Authentication required. Please run "sealos login" first.');
+    throw new Error('Authentication required. Please run "sealos-cli login" first.');
   }
   return headers;
 }
@@ -398,7 +398,7 @@ __name(loginWithDeviceFlow, "loginWithDeviceFlow");
 async function listWorkspaces(deps = {}) {
   const auth = loadAuth(deps);
   if (!auth.regional_token) {
-    throw new Error("No regional_token found. Please run: sealos login");
+    throw new Error("No regional_token found. Please run: sealos-cli login");
   }
   const workspaces = await listRemoteWorkspaces(auth.region, auth.regional_token, deps);
   return {
@@ -415,12 +415,12 @@ async function listWorkspaces(deps = {}) {
 __name(listWorkspaces, "listWorkspaces");
 async function switchWorkspace(target, deps = {}) {
   if (!target) {
-    throw new Error("Usage: sealos auth switch <namespace-id-or-uid>");
+    throw new Error("Usage: sealos-cli auth switch <namespace-id-or-uid>");
   }
   const fullDeps = withDeps(deps);
   const auth = loadAuth(fullDeps);
   if (!auth.regional_token) {
-    throw new Error("No regional_token found. Please run: sealos login");
+    throw new Error("No regional_token found. Please run: sealos-cli login");
   }
   const workspaces = await listRemoteWorkspaces(auth.region, auth.regional_token, fullDeps);
   if (workspaces.length === 0) {
@@ -3388,11 +3388,7 @@ var StdinDiscarder = class {
     }
     const code = typeof chunk === "string" ? chunk.codePointAt(0) : chunk[0];
     if (code === ASCII_ETX_CODE) {
-      if (import_node_process5.default.listenerCount("SIGINT") > 0) {
-        import_node_process5.default.emit("SIGINT");
-      } else {
-        import_node_process5.default.kill(import_node_process5.default.pid, "SIGINT");
-      }
+      import_node_process5.default.kill(import_node_process5.default.pid, "SIGINT");
     }
   }, "#handleInputBound");
   start() {
@@ -3449,6 +3445,7 @@ var RENDER_DEFERRAL_TIMEOUT = 200;
 var SYNCHRONIZED_OUTPUT_ENABLE = "\x1B[?2026h";
 var SYNCHRONIZED_OUTPUT_DISABLE = "\x1B[?2026l";
 var activeHooksPerStream = /* @__PURE__ */ new Map();
+var validColors = /* @__PURE__ */ new Set(["black", "red", "green", "yellow", "blue", "magenta", "cyan", "white", "gray"]);
 var Ora = class {
   static {
     __name(this, "Ora");
@@ -3465,7 +3462,7 @@ var Ora = class {
   #drainHandler;
   #deferRenderTimer;
   #isDiscardingStdin = false;
-  color;
+  #color;
   // Helper to execute writes while preventing hook recursion
   #internalWrite(fn) {
     this.#isInternalWrite = true;
@@ -3550,6 +3547,9 @@ var Ora = class {
     if (typeof this.#options.isSilent !== "boolean") {
       this.#options.isSilent = false;
     }
+    if (this.#options.interval !== void 0 && !(Number.isInteger(this.#options.interval) && this.#options.interval > 0)) {
+      throw new Error("The `interval` option must be a positive integer");
+    }
     const userInterval = this.#options.interval;
     this.spinner = this.#options.spinner;
     this.#options.interval = userInterval;
@@ -3664,6 +3664,15 @@ var Ora = class {
     }
     return count;
   }
+  get color() {
+    return this.#color;
+  }
+  set color(value) {
+    if (value !== void 0 && value !== false && !validColors.has(value)) {
+      throw new Error("The `color` option must be a valid color or `false` to disable");
+    }
+    this.#color = value;
+  }
   get isEnabled() {
     return this.#options.isEnabled && !this.#options.isSilent;
   }
@@ -3690,8 +3699,8 @@ var Ora = class {
     }
     const { frames } = this.#spinner;
     let frame = frames[this.#frameIndex];
-    if (this.color) {
-      frame = source_default[this.color](frame);
+    if (this.#color) {
+      frame = source_default[this.#color](frame);
     }
     const fullPrefixText = this.#getFullPrefixText(this.#options.prefixText, " ");
     const fullText = typeof this.text === "string" ? " " + this.text : "";
@@ -3938,7 +3947,7 @@ var AuthError = class extends CliError {
   static {
     __name(this, "AuthError");
   }
-  constructor(message = 'Authentication required. Please run "sealos login" first.') {
+  constructor(message = 'Authentication required. Please run "sealos-cli login" first.') {
     super(message, 1);
     this.name = "AuthError";
   }
@@ -4739,7 +4748,7 @@ function resolveHost(options) {
   }
   const host = options?.baseUrl || process.env.SEALOS_REGION || authRegion || DEFAULT_SEALOS_REGION;
   if (!host) {
-    throw new ConfigError('No Sealos Cloud host configured. Run "sealos login <host>" first.');
+    throw new ConfigError('No Sealos Cloud host configured. Run "sealos-cli login <host>" first.');
   }
   return host.replace(/\/+$/, "");
 }
@@ -5702,7 +5711,7 @@ function createDatabaseCommand() {
     }
     ctx.spinner.succeed(`Database "${data.name}" created successfully`);
     console.log(source_default.dim(`  Provisioning status: ${data.status}`));
-    console.log(source_default.dim(`  Next: sealos database get ${data.name}`));
+    console.log(source_default.dim(`  Next: sealos-cli database get ${data.name}`));
   }));
   dbCmd.command("get <name>").alias("describe").description("Get database details").option("-o, --output <format>", "Output format (json|table)", "table").action(withAuth({ spinnerText: "Loading database..." }, async (ctx, name, options) => {
     const client = createDatabaseClient();
@@ -6241,14 +6250,14 @@ function createTemplateCommand() {
   tplCmd.command("deploy [template]").description("Deploy a template (from catalog or raw YAML)").option("--name <name>", "Instance name (required when deploying from catalog)").option("--file <path>", "Path to template YAML file").option("--yaml <yaml>", "Template YAML string").option("--set <KEY=VALUE...>", "Set template arguments", (val, prev) => [...prev, val], []).option("--dry-run", "Validate raw template YAML without creating resources").addHelpText("after", `
 Examples:
   Catalog:
-    sealos template deploy perplexica --name my-app --set OPENAI_API_KEY=xxx
+    sealos-cli template deploy perplexica --name my-app --set OPENAI_API_KEY=xxx
 
   Raw:
-    sealos template deploy --file ./template.yaml --dry-run
-    sealos template deploy --yaml 'apiVersion: app.sealos.io/v1
+    sealos-cli template deploy --file ./template.yaml --dry-run
+    sealos-cli template deploy --yaml 'apiVersion: app.sealos.io/v1
 kind: Template
 ...'
-    cat template.yaml | sealos template deploy --dry-run
+    cat template.yaml | sealos-cli template deploy --dry-run
 `).action(async (template, options) => {
     const mode = resolveTemplateDeployMode(template, options);
     await deployTemplate(template, options, mode);
@@ -6257,10 +6266,125 @@ kind: Template
 }
 __name(createTemplateCommand, "createTemplateCommand");
 
+// package.json
+var package_default = {
+  name: "sealos-cli",
+  version: "1.1.1",
+  description: "Official CLI tool for Sealos Cloud - Manage auth, workspaces, devboxes, databases, and templates",
+  types: "dist/main.d.ts",
+  type: "module",
+  bin: {
+    "sealos-cli": "dist/bin/cli.cjs"
+  },
+  exports: {
+    ".": {
+      import: {
+        types: "./dist/main.d.ts",
+        default: "./dist/main.mjs"
+      },
+      require: {
+        types: "./dist/main.d.cts",
+        default: "./dist/main.cjs"
+      },
+      default: "./dist/main.mjs"
+    },
+    "./dist/*": {
+      types: "./dist/*.d.ts",
+      import: "./dist/*.mjs",
+      require: "./dist/*.cjs"
+    }
+  },
+  engines: {
+    node: ">=22.0.0"
+  },
+  packageManager: "npm@8.4.0",
+  files: [
+    "dist",
+    "src",
+    "bin"
+  ],
+  scripts: {
+    start: "node --import tsx src/bin/cli.ts",
+    "generate:api": "openapi-typescript src/docs/template_openapi.json -o src/generated/template.ts && openapi-typescript src/docs/database_openapi.json -o src/generated/database.ts && openapi-typescript src/docs/devbox_openapi.json -o src/generated/devbox.ts",
+    build: "npm run generate:api && tsc && tsup",
+    lint: "eslint . && npm run lint:lockfile && npm run lint:markdown",
+    "lint:markdown": "npx -y markdownlint-cli@0.45.0 -c .github/.markdownlint.yml -i '.git' -i '__tests__' -i '.github' -i '.changeset' -i 'CODE_OF_CONDUCT.md' -i 'CHANGELOG.md' -i 'docs/**' -i 'node_modules' -i 'dist' '**/**.md' --fix",
+    "lint:fix": "eslint . --fix",
+    "lint:lockfile": "lockfile-lint --path package-lock.json --validate-https --allowed-hosts npm yarn",
+    test: "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "coverage:view": "open coverage/lcov-report/index.html",
+    version: "changeset version",
+    release: "changeset publish"
+  },
+  author: {
+    name: "zjy365",
+    email: "3161362058@qq.com",
+    url: "https://github.com/zjy365"
+  },
+  publishConfig: {
+    provenance: true,
+    access: "public"
+  },
+  license: "Apache-2.0",
+  keywords: [
+    "sealos",
+    "cli",
+    "cloud",
+    "devbox",
+    "database",
+    "kubernetes",
+    "deployment",
+    "template",
+    "workspace"
+  ],
+  homepage: "https://github.com/zjy365/sealos-cli.git",
+  bugs: {
+    url: "https://github.com/zjy365/sealos-cli.git/issues"
+  },
+  repository: {
+    type: "git",
+    url: "git+https://github.com/zjy365/sealos-cli.git"
+  },
+  dependencies: {
+    axios: "^1.15.0",
+    chalk: "^5.2.0",
+    commander: "^14.0.3",
+    "openapi-fetch": "^0.17.0",
+    ora: "^9.3.0",
+    table: "^6.8.1"
+  },
+  devDependencies: {
+    "@changesets/changelog-github": "^0.5.0",
+    "@changesets/cli": "^2.27.7",
+    "@types/node": "^20.14.10",
+    "@vitest/coverage-v8": "^4.1.6",
+    eslint: "^9.6.0",
+    "eslint-plugin-security": "^3.0.1",
+    husky: "^9.0.11",
+    "lint-staged": "^15.2.7",
+    "lockfile-lint": "^4.14.0",
+    neostandard: "^0.11.0",
+    "openapi-typescript": "^7.13.0",
+    "ts-node": "^10.9.2",
+    tsup: "^8.1.0",
+    tsx: "^4.19.4",
+    typescript: "^5.5.3",
+    "validate-conventional-commit": "^1.0.4",
+    vitest: "^4.1.6"
+  },
+  "lint-staged": {
+    "**/*.{js,json}": [
+      "npm run lint:fix"
+    ]
+  }
+};
+
 // src/main.ts
 function createProgram() {
   const program = new import_commander9.Command();
-  program.name("sealos").description("Official CLI tool for Sealos Cloud - Manage devbox, databases, templates, auth, and workspaces").version("0.0.1");
+  program.name("sealos-cli").description("Official CLI tool for Sealos Cloud - Manage devbox, databases, templates, auth, and workspaces").version(package_default.version);
   registerAuthCommands(program);
   program.addCommand(createWorkspaceCommand());
   program.addCommand(createDevboxCommand());