sealos-cli 1.0.0 → 1.1.1

package/dist/main.mjs

@@ -68,7 +68,7 @@ __name(saveAuth, "saveAuth");
 function loadAuth(deps = {}) {
   const { paths } = withDeps(deps);
   if (!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(readFileSync(paths.authPath, "utf-8"));
 }
@@ -90,7 +90,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;
 }
@@ -376,7 +376,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 {
@@ -393,12 +393,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) {
@@ -3366,11 +3366,7 @@ var StdinDiscarder = class {
     }
     const code = typeof chunk === "string" ? chunk.codePointAt(0) : chunk[0];
     if (code === ASCII_ETX_CODE) {
-      if (process7.listenerCount("SIGINT") > 0) {
-        process7.emit("SIGINT");
-      } else {
-        process7.kill(process7.pid, "SIGINT");
-      }
+      process7.kill(process7.pid, "SIGINT");
     }
   }, "#handleInputBound");
   start() {
@@ -3427,6 +3423,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");
@@ -3443,7 +3440,7 @@ var Ora = class {
   #drainHandler;
   #deferRenderTimer;
   #isDiscardingStdin = false;
-  color;
+  #color;
   // Helper to execute writes while preventing hook recursion
   #internalWrite(fn) {
     this.#isInternalWrite = true;
@@ -3528,6 +3525,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;
@@ -3642,6 +3642,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;
   }
@@ -3668,8 +3677,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 : "";
@@ -3916,7 +3925,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";
   }
@@ -4717,7 +4726,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(/\/+$/, "");
 }
@@ -5680,7 +5689,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();
@@ -6219,14 +6228,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);
@@ -6235,10 +6244,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 Command9();
-  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());

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "sealos-cli",
-  "version": "1.0.0",
-  "description": "Official CLI tool for Sealos Cloud - Manage devbox, applications, databases, and object storage",
+  "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": {
@@ -64,10 +64,11 @@
     "cli",
     "cloud",
     "devbox",
-    "s3",
     "database",
     "kubernetes",
-    "deployment"
+    "deployment",
+    "template",
+    "workspace"
   ],
   "homepage": "https://github.com/zjy365/sealos-cli.git",
   "bugs": {

package/src/commands/app/index.ts

@@ -3,16 +3,17 @@ import { handleError } from '../../lib/errors.ts'
 
 export function createAppCommand (): Command {
   const appCmd = new Command('app')
-    .description('Manage applications')
+    .description('Future application placeholder outside the v1 release surface')
 
-  // TODO: 实现应用相关命令
+  // Future, non-v1 placeholder. Do not register this command until application
+  // APIs are implemented and ready for release.
 
   appCmd
     .command('list')
-    .description('List all applications')
+    .description('Future application list placeholder outside the v1 release surface')
     .action(async () => {
       try {
-        console.log('TODO: Implement app list')
+        console.log('Application commands are not part of the v1 release surface yet.')
       } catch (error) {
         handleError(error)
       }

package/src/commands/database/index.ts

@@ -445,7 +445,7 @@ export function createDatabaseCommand (): Command {
 
       ctx.spinner.succeed(`Database "${data.name}" created successfully`)
       console.log(chalk.dim(`  Provisioning status: ${data.status}`))
-      console.log(chalk.dim(`  Next: sealos database get ${data.name}`))
+      console.log(chalk.dim(`  Next: sealos-cli database get ${data.name}`))
     }))
 
   dbCmd

package/src/commands/quota/index.ts

@@ -3,16 +3,17 @@ import { handleError } from '../../lib/errors.ts'
 
 export function createQuotaCommand (): Command {
   const quotaCmd = new Command('quota')
-    .description('View resource quotas')
+    .description('Future quota placeholder outside the v1 release surface')
 
-  // TODO: 实现配额相关命令
+  // Future, non-v1 placeholder. Do not register this command until quota APIs
+  // are implemented and ready for release.
 
   quotaCmd
     .command('get')
     .description('Get quota information')
     .action(async () => {
       try {
-        console.log('TODO: Implement quota get')
+        console.log('Quota commands are not part of the v1 release surface yet.')
       } catch (error) {
         handleError(error)
       }

package/src/commands/s3/index.ts

@@ -3,9 +3,10 @@ import { handleError } from '../../lib/errors.ts'
 
 export function createS3Command (): Command {
   const s3Cmd = new Command('s3')
-    .description('Manage S3 object storage')
+    .description('Future S3 placeholder outside the v1 release surface')
 
-  // TODO: 实现 S3 相关命令
+  // Future, non-v1 placeholder. Do not register this command until the S3 API
+  // integration is implemented and ready for release.
   // - upload
   // - download
   // - list
@@ -22,14 +23,13 @@ export function createS3Command (): Command {
     .option('--acl <acl>', 'Access control: private, public-read')
     .action(async (source, destination, options) => {
       try {
-        console.log('TODO: Implement s3 upload', { source, destination, options })
+        console.log('S3 commands are not part of the v1 release surface yet.', { source, destination, options })
       } catch (error) {
         handleError(error)
       }
     })
 
-  // 其他命令...
-  // 为了简洁，这里只实现 upload 作为示例
+  // This file is kept as a marker for future S3 work only.
 
   return s3Cmd
 }

package/src/commands/template/index.ts

@@ -364,12 +364,12 @@ export function createTemplateCommand (): Command {
     .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\nkind: Template\n...'
-    cat template.yaml | sealos template deploy --dry-run
+    sealos-cli template deploy --file ./template.yaml --dry-run
+    sealos-cli template deploy --yaml 'apiVersion: app.sealos.io/v1\nkind: Template\n...'
+    cat template.yaml | sealos-cli template deploy --dry-run
 `)
     .action(async (template: string | undefined, options: TemplateDeployOptions) => {
       const mode = resolveTemplateDeployMode(template, options)

package/src/lib/api-client.ts

@@ -15,7 +15,7 @@ function resolveHost (options?: { baseUrl?: string }): string {
 
   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(/\/+$/, '')
 }

package/src/lib/auth.ts

@@ -141,7 +141,7 @@ export function saveAuth (auth: SealosAuthData, deps: AuthDependencies = {}): vo
 export function loadAuth (deps: AuthDependencies = {}): SealosAuthData {
   const { paths } = withDeps(deps)
   if (!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(readFileSync(paths.authPath, 'utf-8')) as SealosAuthData
@@ -172,7 +172,7 @@ export function getAuthHeaders (deps: AuthDependencies = {}): { Authorization: s
 export function requireAuth (deps: AuthDependencies = {}): { Authorization: string } {
   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
 }
@@ -496,7 +496,7 @@ export async function loginWithDeviceFlow (region?: string, deps: AuthDependenci
 export async function listWorkspaces (deps: AuthDependencies = {}): Promise<WorkspaceListResult> {
   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)
@@ -514,13 +514,13 @@ export async function listWorkspaces (deps: AuthDependencies = {}): Promise<Work
 
 export async function switchWorkspace (target: string, deps: AuthDependencies = {}): Promise<SwitchWorkspaceResult> {
   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)

package/src/lib/errors.ts

@@ -14,7 +14,7 @@ export class CliError extends Error {
  * Authentication error
  */
 export class AuthError extends CliError {
-  constructor (message: string = 'Authentication required. Please run "sealos login" first.') {
+  constructor (message: string = 'Authentication required. Please run "sealos-cli login" first.') {
     super(message, 1)
     this.name = 'AuthError'
   }

package/src/lib/output.ts

@@ -10,12 +10,11 @@ export function outputJson (data: any): void {
 }
 
 /**
- * Output YAML format
+ * Output YAML format.
+ * Generic YAML output is not part of the v1 command surface.
  */
-export function outputYaml (data: any): void {
-  // TODO: Use yaml library to implement
-  console.log('YAML output not implemented yet')
-  console.log(data)
+export function outputYaml (_data: any): never {
+  throw new Error('YAML output is not supported in the v1 release. Use json or table output.')
 }
 
 /**
@@ -87,7 +86,7 @@ export function spinner (text: string): Ora {
  * Confirmation prompt
  */
 export async function confirm (message: string): Promise<boolean> {
-  // TODO: Use inquirer or other interactive library
+  // Non-interactive default for v1. Replace with a prompt implementation when needed.
   console.log(chalk.yellow('?'), message)
   return true
 }

package/src/main.ts

@@ -6,14 +6,15 @@ import { createDevboxCommand } from './commands/devbox/index.ts'
 import { createDatabaseCommand } from './commands/database/index.ts'
 import { createTemplateCommand } from './commands/template/index.ts'
 import { handleError } from './lib/errors.ts'
+import packageJson from '../package.json' with { type: 'json' }
 
 export function createProgram (): Command {
   const program = new Command()
 
   program
-    .name('sealos')
+    .name('sealos-cli')
     .description('Official CLI tool for Sealos Cloud - Manage devbox, databases, templates, auth, and workspaces')
-    .version('0.0.1')
+    .version(packageJson.version)
 
   // Register all command modules
   registerAuthCommands(program)