feat #232: process-compose ls

F1bonacc1 · Sep 13, 2024 · 5441a34 · 5441a34
1 parent b230d41
commit 5441a34
Show file tree

Hide file tree

Showing 4 changed files with 36 additions and 0 deletions.
diff --git a/src/cmd/list.go b/src/cmd/list.go
@@ -101,6 +101,7 @@ func printStatesAsTable(states []types.ProcessState) {
 
 func init() {
 	processCmd.AddCommand(listCmd)
+	rootCmd.AddCommand(listCmd)
 
 	listCmd.Flags().StringVarP(pcFlags.OutputFormat, "output", "o", *pcFlags.OutputFormat, "Output format. One of: (json, wide)")
 }
diff --git a/src/config/config.go b/src/config/config.go
@@ -43,6 +43,8 @@ var (
 		"attach",
 		"process",
 		"project",
+		"list",
+		"ls",
 	}
 )
 

diff --git a/www/docs/cli/process-compose.md b/www/docs/cli/process-compose.md
@@ -38,6 +38,7 @@ process-compose [flags]
 * [process-compose completion](process-compose_completion.md)	 - Generate the autocompletion script for the specified shell
 * [process-compose down](process-compose_down.md)	 - Stops all the running processes and terminates the Process Compose
 * [process-compose info](process-compose_info.md)	 - Print configuration info
+* [process-compose list](process-compose_list.md)	 - List available processes
 * [process-compose process](process-compose_process.md)	 - Execute operations on the available processes
 * [process-compose project](process-compose_project.md)	 - Execute operations on a running Process Compose project
 * [process-compose run](process-compose_run.md)	 - Run PROCESS in the foreground, and its dependencies in the background

diff --git a/www/docs/cli/process-compose_list.md b/www/docs/cli/process-compose_list.md
@@ -0,0 +1,32 @@
+## process-compose list
+
+List available processes
+
+```
+process-compose list [flags]
+```
+
+### Options
+
+```
+  -h, --help            help for list
+  -o, --output string   Output format. One of: (json, wide)
+```
+
+### Options inherited from parent commands
+
+```
+  -L, --log-file string      Specify the log file path (env: PC_LOG_FILE) (default "/tmp/process-compose-<user>.log")
+      --no-server            disable HTTP server (env: PC_NO_SERVER)
+      --ordered-shutdown     shut down processes in reverse dependency order
+  -p, --port int             port number (env: PC_PORT_NUM) (default 8080)
+      --read-only            enable read-only mode (env: PC_READ_ONLY)
+  -u, --unix-socket string   path to unix socket (env: PC_SOCKET_PATH) (default "/tmp/process-compose-<pid>.sock")
+  -U, --use-uds              use unix domain sockets instead of tcp
+```
+
+### SEE ALSO
+
+* [process-compose](process-compose.md)	 - Processes scheduler and orchestrator
+
+###### Auto generated by spf13/cobra on 13-Sep-2024