update: fix cmdLong and add useage

- we have 3 ways to run it
  1. kubectl odh XXXX : download pre-build binary and rename it
  2. odh-cli XXXX : download pre-build binary and use it directly
  3. podman run XXXX : pull pre-build image and run inside container

Signed-off-by: Wen Zhou <wenzhou@redhat.com>

Author: zdtsw

.goreleaser.yml

@@ -1,15 +1,15 @@
 version: 2
 
-project_name: kubectl-odh
+project_name: odh-cli
 
 before:
   hooks:
     - go mod tidy
 
 builds:
-  - id: kubectl-odh
+  - id: odh-cli
     main: ./cmd/main.go
-    binary: kubectl-odh
+    binary: odh-cli
     env:
       - CGO_ENABLED=0
     goos:

README.md

@@ -9,6 +9,40 @@ CLI tool for ODH/RHOAI (Red Hat OpenShift AI) for interacting with ODH/RHOAI dep
 
 ## Quick Start
 
+### Using Pre-built Binary
+
+Download the latest release from [GitHub Releases](https://github.com/opendatahub-io/odh-cli/releases):
+
+```bash
+# Download and extract (example for Linux amd64)
+curl -LO https://github.com/opendatahub-io/odh-cli/releases/latest/download/odh-cli_linux_amd64.tar.gz
+tar -xzf odh-cli_linux_amd64.tar.gz
+
+# Make it avaiable on PATH
+sudo mv odh-cli /usr/local/bin/
+
+# Verify installation
+odh-cli version
+
+# Run commands
+odh-cli lint --target-version 3.3.0
+```
+
+**As kubectl Plugin (optional):**
+
+To use as `kubectl odh`, rename or symlink the binary after download it:
+
+```bash
+# Option 1: Rename
+sudo mv odh-cli /usr/local/bin/kubectl-odh
+
+# Option 2: Symlink (keeps both names available)
+sudo ln -s /usr/local/bin/odh-cli /usr/local/bin/kubectl-odh
+
+# Now use with kubectl
+kubectl odh lint --target-version 3.3.0
+```
+
 ### Using Containers
 
 Run the CLI using the pre-built container image. Set your container runtime (podman or docker):

cmd/backup/backup.go

@@ -20,6 +20,12 @@ const cmdLong = `
 Backs up OpenShift AI workloads (notebooks, etc.) and their dependencies
 (ConfigMaps, Secrets, PVCs) to a directory structure.
 
+INVOCATION:
+  The examples below use 'odh-cli'. Depending on your setup, substitute with:
+    - Container:       podman|docker run <image> backup ...
+    - kubectl plugin:  kubectl odh backup ...
+    - Direct binary:   odh-cli backup ...
+
 The backup command:
   - Discovers workload resources based on --includes/--exclude filters
   - For each workload, identifies and backs up referenced dependencies

cmd/lint/lint.go

@@ -19,6 +19,12 @@ const (
 const cmdLong = `
 Validates the current OpenShift AI installation or assesses upgrade readiness.
 
+INVOCATION:
+  The examples below use 'odh-cli'. Depending on your setup, substitute with:
+    - Container:       podman|docker run <image> lint ...
+    - kubectl plugin:  kubectl odh lint ...
+    - Direct binary:   odh-cli lint ...
+
 LINT MODE (without --target-version):
   Validates the current cluster state and reports configuration issues.
 
@@ -38,32 +44,32 @@ Each issue is reported with:
 
 Examples:
   # Validate current cluster state
-  kubectl odh lint
+  odh-cli lint
 
   # Assess upgrade readiness for version 3.0
-  kubectl odh lint --target-version 3.0
+  odh-cli lint --target-version 3.0
 
   # Validate with JSON output
-  kubectl odh lint -o json
+  odh-cli lint -o json
 
   # Validate only component checks
-  kubectl odh lint --checks "components"
+  odh-cli lint --checks "components"
 `
 const cmdExample = `
   # Validate current cluster state
-  kubectl odh lint
+  odh-cli lint
 
   # Assess upgrade readiness for version 3.0
-  kubectl odh lint --target-version 3.0
+  odh-cli lint --target-version 3.0
 
   # Output results in JSON format
-  kubectl odh lint -o json
+  odh-cli lint -o json
 
   # Run only dashboard-related checks
-  kubectl odh lint --checks "*dashboard*"
+  odh-cli lint --checks "*dashboard*"
 
   # Check upgrade readiness to version 3.1
-  kubectl odh lint --target-version 3.1
+  odh-cli lint --target-version 3.1
 `
 
 // AddCommand adds the lint command to the root command.

cmd/migrate/list/list.go

@@ -26,13 +26,13 @@ migrations without version filtering, or --target-version to filter by applicabi
 
 const cmdExample = `
   # List applicable migrations for version 3.0
-  kubectl odh migrate list --target-version 3.0.0
+  odh-cli migrate list --target-version 3.0.0
 
   # List all migrations without version filtering
-  kubectl odh migrate list --all
+  odh-cli migrate list --all
 
   # List with JSON output
-  kubectl odh migrate list --target-version 3.0.0 -o json
+  odh-cli migrate list --target-version 3.0.0 -o json
 `
 
 // AddCommand adds the list subcommand to the migrate command.

cmd/migrate/migrate.go

@@ -19,6 +19,12 @@ const (
 const cmdLong = `
 The migrate command manages cluster migrations for OpenShift AI components.
 
+INVOCATION:
+  The examples below use 'odh-cli'. Depending on your setup, substitute with:
+    - Container:       podman|docker run <image> migrate ...
+    - kubectl plugin:  kubectl odh migrate ...
+    - Direct binary:   odh-cli migrate ...
+
 Use 'migrate list' to see available migrations filtered by version compatibility.
 Use 'migrate prepare' to backup resources before migration.
 Use 'migrate run' to execute one or more migrations sequentially.
@@ -35,22 +41,22 @@ Available subcommands:
 
 const cmdExample = `
   # List available migrations for version 3.0
-  kubectl odh migrate list --target-version 3.0.0
+  odh-cli migrate list --target-version 3.0.0
 
   # List all migrations including non-applicable ones
-  kubectl odh migrate list --all
+  odh-cli migrate list --all
 
   # Prepare for migration (creates backups)
-  kubectl odh migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0
+  odh-cli migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0
 
   # Run a migration with confirmation prompts
-  kubectl odh migrate run --migration kueue.rhbok.migrate --target-version 3.0.0
+  odh-cli migrate run --migration kueue.rhbok.migrate --target-version 3.0.0
 
   # Run migration in dry-run mode (preview changes only)
-  kubectl odh migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --dry-run
+  odh-cli migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --dry-run
 
   # Run multiple migrations sequentially
-  kubectl odh migrate run --migration kueue.rhbok.migrate --migration other.migration --target-version 3.0.0 --yes
+  odh-cli migrate run --migration kueue.rhbok.migrate --migration other.migration --target-version 3.0.0 --yes
 `
 
 // AddCommand adds the migrate command to the root command.

cmd/migrate/prepare/prepare.go

@@ -30,19 +30,19 @@ Use --output-dir to specify where backups should be written.
 
 const cmdExample = `
   # Prepare for a single migration (creates timestamped backup directory)
-  kubectl odh migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0
+  odh-cli migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0
 
   # Prepare with custom backup directory
-  kubectl odh migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0 --output-dir /path/to/backups
+  odh-cli migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0 --output-dir /path/to/backups
 
   # Preview what would be backed up (dry-run mode)
-  kubectl odh migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0 --dry-run
+  odh-cli migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0 --dry-run
 
   # Prepare without confirmation prompts
-  kubectl odh migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0 --yes
+  odh-cli migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0 --yes
 
   # Prepare multiple migrations sequentially
-  kubectl odh migrate prepare -m kueue.rhbok.migrate -m other.migration --target-version 3.0.0
+  odh-cli migrate prepare -m kueue.rhbok.migrate -m other.migration --target-version 3.0.0
 `
 
 // AddCommand adds the prepare subcommand to the migrate command.

cmd/migrate/run/run.go

@@ -26,20 +26,20 @@ Use 'migrate prepare' to backup resources before running migrations.
 
 const cmdExample = `
   # Run a single migration with confirmation prompts
-  kubectl odh migrate run --migration kueue.rhbok.migrate --target-version 3.0.0
+  odh-cli migrate run --migration kueue.rhbok.migrate --target-version 3.0.0
 
   # Run migration in dry-run mode (verbose is automatically enabled)
-  kubectl odh migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --dry-run
+  odh-cli migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --dry-run
 
   # Run migration without confirmation prompts
-  kubectl odh migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --yes
+  odh-cli migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --yes
 
   # Run multiple migrations sequentially
-  kubectl odh migrate run -m kueue.rhbok.migrate -m other.migration --target-version 3.0.0
+  odh-cli migrate run -m kueue.rhbok.migrate -m other.migration --target-version 3.0.0
 
   # Typical workflow: prepare first, then run
-  kubectl odh migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0
-  kubectl odh migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --yes
+  odh-cli migrate prepare --migration kueue.rhbok.migrate --target-version 3.0.0
+  odh-cli migrate run --migration kueue.rhbok.migrate --target-version 3.0.0 --yes
 `
 
 // AddCommand adds the run subcommand to the migrate command.

docs/usage.md

@@ -35,12 +35,23 @@ go run github.com/opendatahub-io/odh-cli/cmd@latest \
 
 ## As kubectl Plugin
 
-Install the `kubectl-odh` binary to your PATH:
+To use as a kubectl plugin, rename or symlink the `odh-cli` binary:
 
 ```bash
-# Download from releases
-# Place in PATH as kubectl-odh
+# Download from GitHub releases
+curl -LO https://github.com/opendatahub-io/odh-cli/releases/latest/download/odh-cli_linux_amd64.tar.gz
+tar -xzf odh-cli_linux_amd64.tar.gz
+
+# Option 1: Rename to kubectl-odh for kubectl to auto discovery
+sudo mv odh-cli /usr/local/bin/kubectl-odh
+
+# Option 2: Symlink (keeps both names available)
+sudo mv odh-cli /usr/local/bin/
+sudo ln -s /usr/local/bin/odh-cli /usr/local/bin/kubectl-odh
+
 # Use with kubectl
 kubectl odh lint --target-version 3.3.0
-kubectl odh version
+
+# or just use directly
+odh-cli lint --target-version 3.3.0
 ```