From 79af24cdab1d78fec7214d1ff12bfca6550045d5 Mon Sep 17 00:00:00 2001
From: Nicklas Utgaard <nutgaard@gmail.com>
Date: Thu, 14 Nov 2024 09:11:07 +0100
Subject: [PATCH] fix: add help descriptions and updated readme

---
 README.md               | 89 ++++++++++++++++++++++++++++++++++++++++-
 src/commands/inspect.ts |  1 +
 src/commands/run.ts     |  1 +
 3 files changed, 90 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8e54662..0589799 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,84 @@
 # dktp
 
+A simple cli to interact with Azure ContainerApps with arm/yaml templates
+
+## Usage
+
+```shell
+Usage: dktp [options] [command]
+
+CLI to help working dktp apps
+
+Options:
+  -h, --help                                display help for command
+
+Commands:
+  wrap [options] <configfile> [outputfile]  Download secrets, and encrypt environment
+  run [options] <env_file> <command...>     Run command with environment variables from lock-file
+  inspect [options] <env_file>              Print content of encrypted lock-file
+  help [command]                            display help for command
+```
+
+### Wrap: Download and encrypt environment
+
+```shell
+Usage: dktp wrap [options] <configfile> [outputfile]
+
+Download secrets, and encrypt environment
+
+Arguments:
+  configfile                        Path to dktp yaml file
+  outputfile                        Path to encrypted vault file
+
+Options:
+  -c, --container <container_name>  Container name to process (defaults to create a combined env file)
+  -e, --env <env_file>              Envfile to use for interpolation
+  -h, --help                        display help for command
+  
+  
+Example: dktp wrap example/main.yml -e example/prod.env example/prod.env.locked
+```
+
+### Run: Start a process with environment variable set
+
+```shell
+Usage: dktp run [options] <env_file> <command...>
+
+Run command with environment variables from lock-file
+
+Arguments:
+  env_file                      Envfile to use for process
+  command                       The command to run
+
+Options:
+  -o, --override [keyvalue...]  Override or pass extra environment variable, e.g MY_VAR=abba (default: {})
+  -h, --help                    display help for command
+  
+  
+Example: dktp run example/prod.env.locked -o APP_NAME=Hello -- node index.mjs
+```
+
+### Inspect: Print the content of a encrypted lock-file
+
+```shell
+Usage: dktp inspect [options] <env_file>
+
+Print content of encrypted lock-file
+
+Arguments:
+  env_file                      File to inspect
+
+Options:
+  -o, --override [keyvalue...]  Override or pass extra environment variable, e.g MY_VAR=abba (default: {})
+  -h, --help                    display help for command
+  
+  
+Example: dktp inspect example/prod.env.locked -o APP_NAME=Hello
+```
+
+
+
+## Contribution
 To install dependencies:
 
 ```bash
@@ -12,4 +91,12 @@ To run:
 bun run src/index.ts
 ```
 
-This project was created using `bun init` in bun v1.0.30. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime.
+To test wrapping of secrets;
+1. Update [targetPlatform.ts](src/utils/targetPlatform.ts) to set `AZ_MOCK = true`.
+2. Run `bun run src/index.ts wrap example/main.yml -e example/prod.env example/prod.env.locked`
+
+
+### Commiting changes
+
+This repository uses commitizen and conventional-changelog to determine which new semver-version should be used in a release.
+To help with keeping your commits correctly formatted please use `bun commit` / `npm run commit`.
\ No newline at end of file
diff --git a/src/commands/inspect.ts b/src/commands/inspect.ts
index 11d4c8c..0a113fd 100644
--- a/src/commands/inspect.ts
+++ b/src/commands/inspect.ts
@@ -8,6 +8,7 @@ import dotenv from 'dotenv';
 
 export const inspectCommand: Command = program
     .createCommand('inspect')
+    .description('Print content of encrypted lock-file')
     .argument('<env_file>', 'File to inspect')
     .option(
         '-o, --override [keyvalue...]',
diff --git a/src/commands/run.ts b/src/commands/run.ts
index dd2328e..26786a2 100644
--- a/src/commands/run.ts
+++ b/src/commands/run.ts
@@ -9,6 +9,7 @@ import { parseEnvEntry } from '../utils/env-utils';
 
 export const runCommand: Command = program
     .createCommand('run')
+    .description('Run command with environment variables from lock-file')
     .argument('<env_file>', 'Envfile to use for process')
     .argument('<command...>', 'The command to run')
     .option(