Skip to content

Commit 50978c4

Browse files
committed
Add more info to piston script help
And make it easier to read
1 parent 09a0ed2 commit 50978c4

1 file changed

Lines changed: 23 additions & 22 deletions

File tree

piston

Lines changed: 23 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -124,31 +124,32 @@ case "$SUBCOMMAND" in
124124
*)
125125
echo "=== Piston Management ==="
126126
echo
127-
echo "Commands:"
128-
echo " logs Show piston logs"
127+
echo "======================"
128+
echo "General Commands"
129+
echo "======================"
130+
echo " logs Show Piston logs"
131+
echo " start Start Piston production container"
132+
echo " stop Stop Piston"
133+
echo " restart Restart Piston"
134+
echo " shell Open a bash shell for the container"
135+
echo " update Fetch latest updates"
136+
echo " exec <language> <file> Execute the files on Piston with language"
129137
echo
130-
echo " start Starts piston"
131-
echo " stop Stops piston"
132-
echo " restart Restarts piston"
133-
echo " shell Opens a bash shell for the api container"
134-
echo
135-
echo " update Fetches latest updates"
136-
echo
137-
echo " exec <language> <file> Execute the files on piston with language"
138-
echo
139-
echo "Development Commands:"
138+
echo "======================"
139+
echo "Development Commands"
140140
echo "Running some of these commands require a nix environment setup and on the path"
141141
echo "See https://nixos.wiki/wiki/Nix_Installation_Guide#Stable_Nix"
142-
echo
143-
echo " start-dev Builds a container locally and starts piston"
144-
echo " build [runtime-set] Builds and loads the API container optionally"
145-
echo " including the runtime set within it"
146-
echo " scaffold <language> [runtime] Initializes a new runtime"
147-
echo " test <runtime> Runs unit tests on the given runtime"
148-
echo " test-dev <runtime> Same as test, but using the development container and volume"
149-
echo " Optionally set runtime to --all to test all"
150-
echo " NOTE: This is only for the runtimes contained"
151-
echo " within this repo"
142+
echo "======================"
143+
echo " build-dev Build the development image"
144+
echo " build [runtime-set] Build the production image, and optionally"
145+
echo " include a specified runtime set"
146+
echo " start-dev Start Piston development container"
147+
echo " scaffold <language> [runtime] Initialize a template for a new runtime"
148+
echo " test <runtime> Run unit tests on the given runtime"
149+
echo " Optionally set runtime to --all to test all"
150+
echo " NOTE: This is only for the runtimes contained"
151+
echo " within this repo"
152+
echo " test-dev <runtime> test using the development container and volume"
152153
echo
153154
;;
154155
esac

0 commit comments

Comments
 (0)