Document CLI commands

[gtsiolis]

Problem

We're currently missing some documentation for the CLI tool.

CLI commands and and reference documentation can be found scattered across a) release notes[1][2][...], community forum posts[3][4][...], comments in the issue tracker, etc.

Proposal

Given there are plans for improving[5] commands and adding[6] new ones, let's create a dedicated section in the documentation (docs.gitpod.io) that includes a command reference with usage guidelines and examples when possible so that we can have a single source of truth (SSOT) we can reference and point to when needed.

See also other examples[7][8][9].

[jankeromnes]

Here are all the current gp commands, as per gp help:

Command line interface for Gitpod

Usage:
  gp [command]

Available Commands:
  await-port        Waits for a process to listen on a port
  env               Controls user-defined, persistent environment variables.
  forward-port      Makes a port available on 0.0.0.0 so that it can be exposed to the internet
  help              Help about any command
  init              Create a Gitpod configuration for this project.
  open              Opens a file in Gitpod
  preview           Opens a URL in Theia's preview view
  sync-await        Awaits an event triggered using gp sync-done
  sync-done         Notifies the corresponding gp sync-await calls that this event has happened
  url               Prints the URL of this workspace

Flags:
  -h, --help   help for gp

Use "gp [command] --help" for more information about a command.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.