Commands

Inside the gs shell you interact with the target by typing commands at the (gs) ❯ prompt. There are two kinds:

• Built-in commands — shell controls that ship with gs (listed below).
• Module commands — every loaded module contributes a command of the same name that runs it against the current target.

List everything available in the current session at any time with help.

Built-in commands

Command	Description
help	List the available commands and flags.
info	Show general information about the tool.
clear	Clear the terminal buffer.
install	Install a module.
uninstall	Remove an installed module.
exit	Exit the gs shell.

help

Prints the built-in commands and the built-in module commands registered in the current session, each with its one-line description, followed by the global flags. (Installed modules stay available as commands even though they aren't listed here.)

(gs) ❯ help

info

Prints general information about the running build — the project links, the gs version, the Go version and platform it was built for, the license, and what GoScouter is for — next to the GoScouter logo.

(gs) ❯ info

clear

Clears the current terminal buffer, like clear/cls in a normal shell.

(gs) ❯ clear

install

Installs a module and registers it as a new command for the rest of the session. It takes a single module reference — the module's Git repository and a version, joined with @:

(gs) ❯ install <repo>@<version>

(gs) ❯ install github.com/GoScouter/nginx-module@1.0.0

GoScouter clones the repository, reads the manifest.json at its root, and picks the release matching your platform and the requested version. It then downloads that binary, verifies its SHA-256 checksum, caches it, and makes the new command available immediately:

Installing nginx@1.0.0
Downloading https://github.com/GoScouter/nginx-module/releases/download/1.0.0/nginx
Installed nginx (…bytes) to ~/.cache/gs/nginx
✓ Command nginx is now available

The reference may include a scheme (https://… or http://…); without one, GoScouter tries https:// first and falls back to http://.

Once installed, invoke it like any other module:

(gs) ❯ nginx

Installed binaries are cached under your user cache directory (for example ~/.cache/gs on Linux) and reload automatically the next time you start gs. See Installing modules for the full flow and Publishing a Module for how references and manifests are built.

TIP

The command name for an installed module comes from its binary file name, not its display name — a binary named nginx is invoked as nginx.

uninstall

Removes a previously installed module by name and unregisters its command:

(gs) ❯ uninstall <module-name>

(gs) ❯ uninstall nginx
Uninstalled nginx from ~/.cache/gs/nginx
✓ Command nginx is no longer available

Only installed modules can be removed; the built-in modules that ship with gs are always present.

exit

Exits the gs shell.

(gs) ❯ exit

You can also press Ctrl-D on an empty line to exit, or Ctrl-C to abandon the line you're currently typing without quitting.

Global flags

Flags are passed to the gs binary on the command line, not at the prompt.

Flag	Description
--target	The site GoScouter targets. Required.

./gs --target https://example.com