Skip to content

Command Line Interface

The GPCORE CLI (gpcore) lets you manage your projects and nodes directly from the terminal without needing to open the web panel. It is well suited for automation, scripting, and users who prefer keyboard-driven workflows. The CLI uses a client/server architecture: a local SSH server (the agent) authenticates with the API once and keeps the session alive, so subsequent commands execute immediately without repeated logins. Binaries are available for Linux, macOS, and Windows.

Installation

Download the latest release for your platform from the GitHub releases page.

# Download the binary (replace <version> with the latest release)
curl -L https://github.com/G-PORTAL/gpcore-cli/releases/latest/download/gpcore-linux-amd64 -o gpcore
chmod +x gpcore
sudo mv gpcore /usr/local/bin/

curl -L https://github.com/G-PORTAL/gpcore-cli/releases/latest/download/gpcore-darwin-amd64 -o gpcore
chmod +x gpcore
sudo mv gpcore /usr/local/bin/

Download gpcore-windows-amd64.exe from the releases page and add it to your PATH.

Architecture

The commandline tool works in two different modes: as a server and as a client.

The server is a standard SSH server which does the heavy lifting. It logs into the GPCORE API once and waits for commands from the client.

The server acts as a proxy between the client and the API. The client connects to the server and sends commands to it. The server executes the commands and returns the result to the client. With this architecture, the client does not open a new connection for every command, which saves time and resources.

Next Steps

  • Setup — configure credentials on first run
  • Usage — available commands and output formats