Generate one-page CLI reference document

.github/workflows/nightly-build.yaml

@@ -17,12 +17,12 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-       
+
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
             go-version-file: 'go.mod'
-    
+
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v5
         with:
@@ -39,8 +39,8 @@ jobs:
           name: 'Nightly Builds Download for KitOps CLI (kit)'
           prerelease: true
           body: |
-            Welcome to the cutting edge! Our nightly builds offer the most recent developments 
-            in kit CLI, providing early access to new features, enhancements, and 
+            Welcome to the cutting edge! Our nightly builds offer the most recent developments
+            in kit CLI, providing early access to new features, enhancements, and
             fixes that are on their way to the next stable release'
           files: |
             ./dist/*.txt

.github/workflows/pr.yaml

@@ -35,7 +35,7 @@ jobs:
 
       - name: Check build
         run: |
-          if ! go build; then
+          if ! go build -o kit; then
             echo "Project does not build"
             exit 1
           fi
@@ -46,3 +46,21 @@ jobs:
             echo "Project tests failed"
             exit 1
           fi
+
+      - name: Check CLI docs generation
+        run: |
+          docs/src/docs/cli/generate.sh > /dev/null
+          if [[ ! -z $(git status -s) ]]; then
+            echo "CLI documentation is out of date"
+            echo "Run docs/src/docs/cli/generate.sh and commit the result"
+            exit 1
+          fi
+
+      - name: Check for trailing whitespace
+        run: |
+          files=$(grep -E -lI --exclude '*.svg' --exclude 'docs/*' " +$" $(git ls-files) || true)
+          if [ ! -z $files ]; then
+            echo "Trailing whitespace in files:"
+            echo "$files"
+            exit 1
+          fi

.github/workflows/release.yaml

@@ -17,12 +17,12 @@ jobs:
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
-       
+
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
             go-version-file: 'go.mod'
-    
+
       - name: Run GoReleaser
         uses: goreleaser/goreleaser-action@v5
         with:

.goreleaser.yaml

@@ -15,8 +15,8 @@ builds:
       - windows
       - darwin
     binary: kit
-    
-    ldflags: 
+
+    ldflags:
       - -s -w -X kitops/pkg/cmd/version.Version={{.Version}} -X kitops/pkg/cmd/version.GitCommit={{.Commit}} -X kitops/pkg/cmd/version.BuildTime={{.Date}}
 
 archives:
@@ -53,6 +53,6 @@ release:
 
   footer: |
     Thanks for supporting Kitops.
-  
+
   name_template: "{{.ProjectName}}-{{.Version}}"
   skip_upload: false

CONTRIBUTING.md

@@ -31,7 +31,7 @@ We welcome many different types of contributions including:
 * Communications, social media, blog posts, or other marketing
 * Release management
 
-Not everything happens through a GitHub pull request. Please contact us in the [#general channel of our Discord server](https://discord.gg/XzSmtPn3) or during our [office hours meeting](./GOVERNANCE.md#meetings) and let's discuss how we can work together. 
+Not everything happens through a GitHub pull request. Please contact us in the [#general channel of our Discord server](https://discord.gg/XzSmtPn3) or during our [office hours meeting](./GOVERNANCE.md#meetings) and let's discuss how we can work together.
 
 ## Development Environment Setup
 
@@ -70,9 +70,9 @@ Git has a `-s` command line option to do this automatically:
     git commit -s -m 'This is my commit message'
 
 If you forgot to do this and have not yet pushed your changes to the remote
-repository, you can amend your commit with the sign-off by running 
+repository, you can amend your commit with the sign-off by running
 
-    git commit --amend -s 
+    git commit --amend -s
 
 ## Pull Request Checklist
 

GOVERNANCE.md

@@ -47,7 +47,7 @@ To become a Maintainer you need to demonstrate the following:
   * Ability to collaborate with the team
   * Understanding of how the team works (policies, processes for testing and code review, etc)
   * Understanding of the project's code base and coding and documentation style
-  
+
 A new Maintainer must be proposed by an existing maintainer by sending a message in the #general channel in the [KitOps Discord server](https://discord.gg/XzSmtPn3). A simple majority vote of existing Maintainers approves the application.  Maintainers nominations will be evaluated without prejudice to employer or demographics.
 
 Maintainers who are selected will be granted the necessary GitHub rights, and invited to the private Maintainers Discord channel.

README.md

@@ -49,7 +49,7 @@ Then run the project:
 ./kit
 ```
 
-Alternatively 
+Alternatively
 
 ```shell
 go run kit

cmd/root.go

@@ -29,7 +29,7 @@ import (
 var (
 	shortDesc = `Streamline the lifecycle of AI/ML models`
 	longDesc  = `Kit is a tool for efficient AI/ML model lifecycle management.
-     
+
 Find more information at: http://kitops.ml`
 )
 

demos/README.md

@@ -6,7 +6,7 @@ Follow these steps to run the demo scripts successfully:
 
 2. **Navigate to the Demo Directory:** Change your current working directory to the demo's directory by using the `cd` command followed by the path to the directory. For example:
 
-```shell 
+```shell
 cd  kitops/demo/
 ```
 
@@ -28,4 +28,4 @@ Make sure that `my-demo.sh` is the correct name of the demo script you intend to
 chmod +x my-demo.sh
 ```
 
-Before running these steps, ensure that you have any dependencies or environmental requirements satisfied which are usually recorded as comments on the `.sh` file. 
+Before running these steps, ensure that you have any dependencies or environmental requirements satisfied which are usually recorded as comments on the `.sh` file.

demos/demo.sh

@@ -35,7 +35,7 @@ fi
 clear
 
 
-pe "./kit version" 
+pe "./kit version"
 
 # Let's check if there are any model kits locally
 pe "./kit list"
@@ -53,7 +53,7 @@ pe "./kit build ../examples/onnx -t localhost:5050/test-repo:test-tag"
 pe "./kit list"
 
 # run a local registry
-pe "$DOCKER run --name registry --rm -d -p 5050:5050 -e REGISTRY_HTTP_ADDR=:5050 registry" 
+pe "$DOCKER run --name registry --rm -d -p 5050:5050 -e REGISTRY_HTTP_ADDR=:5050 registry"
 
 # Let's push the model to the local registry
 pe "./kit push localhost:5050/test-repo:test-tag --http"

docs/src/docs/cli/cli-reference.header

@@ -0,0 +1,2 @@
+# Kit CLI Reference
+