@dmgnr/kuber 1.1.0 → 1.2.1

package/README.md

@@ -67,6 +67,9 @@ bun run index.ts start
 bun run index.ts stop
 bun run index.ts restart
 bun run index.ts db ls
+bun run index.ts s3 ls
+bun run index.ts s3 creds app
+bun run index.ts s3 ui app
 ```
 
 All commands accept `--config` to use a configuration file other than
@@ -102,6 +105,9 @@ For a permanent setup, write the generated script to a file and source it from y
 - `exec <deployment> <command...>`: execute a command inside a running deployment pod
 - `db ls`: list managed Postgres claims declared in the current Compose file
 - `db creds <service>`: print the generated connection details for a managed Postgres claim
+- `s3 ls`: list managed S3 claims declared in the current Compose file
+- `s3 creds <service>`: print all generated S3 environment variables for a service
+- `s3 ui <service>`: print the Garage UI object-browser URL for a service bucket
 
 ## Configuration
 
@@ -137,7 +143,7 @@ export default {
 
 Operational defaults:
 
-- `project`: current working directory name
+- `project`: Compose top-level `name`, falling back to the current working directory name
 - `composeFile`: the first recognized Compose filename in the working directory
 - `registry`: `registry.neko-piranha.ts.net`
 - `builders.amd64`: `kuber@astral-th`
@@ -145,6 +151,9 @@ Operational defaults:
 - `builders.remoteRoot`: `kuber-build`
 - `rolloutTimeoutMs`: `300000`
 
+Project-name precedence is `.kuberrc.ts project`, Compose top-level `name`, then
+the current working directory name.
+
 Configuration hooks can be synchronous or asynchronous and receive mutable
 values:
 
@@ -255,6 +264,18 @@ The Garage operator generates the credentials. `kuber` reads its generated Secre
 
 One service can declare both `postgresql:...` and `s3:...`; all generated values are merged into the same service Secret. Managed Garage buckets and keys are retained by normal `down` and deleted by `down -f`.
 
+Inspect a claim, print its generated credentials, or get its Garage UI URL:
+
+```bash
+kuber s3 ls
+kuber s3 creds app
+kuber s3 ui app
+```
+
+`s3 creds` prints `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`,
+`AWS_ENDPOINT_URL_S3`, `AWS_REGION`, and `S3_BUCKET` as shell-style environment
+assignments. `s3 ui` only prints the URL; it does not open a browser.
+
 ### Environment Files
 
 `env_file` entries are read locally and turned into a Kubernetes `Secret` named `<service>-env`. Deployments then consume that secret through `envFrom`.