The Gigantum User Hub

Welcome to the Gigantum user hub. You'll find comprehensive guides and documentation to help you start working with the Gigantum platform as quickly as possible. If you get stuck, then there is help for that too.

Let's get to it!

Get Started    Changelog

Gigantum CLI

A Python command line tool for managing Gigantum.

The Gigantum Command Line Interface (CLI) is a Python-based command line tool for installing, updating, starting, and stopping Gigantum. It runs on Python 2.7 and 3.4 or higher and can be installed with pip.

The CLI allows you to manage the Gigantum Client from the command line rather than using Gigantum Desktop. This may be especially useful when working with a remote server.

This page assumes that you have already installed Docker (if not, see the Installing Docker section), have Python installed and are able to pip install packages. Also, this page assumes that Docker is already running.

Quick Start

If you already have Docker running and can use pip, then you can install both the CLI and Gigantum, and then start it with the following commands:

  • pip install -U gigantum
  • gigantum install
  • gigantum start

Install the CLI and Gigantum Client

Using a terminal, you can install the CLI and the Gigantum Client in two steps, keeping in mind that the CLI must be installed first using pip.

Just launch a Terminal and then do the following:

  1. Install the CLI with pip install -U gigantum;
  2. Install Gigantum Client container with gigantum install.

Downloading and installing the Gigantum Client container can take a while depending on the speed of your connection. Be patient while it runs in the background after running gigantum install or gigantum update

(Optional) Virtual Environments

To isolate the Gigantum CLI installation from your system Python, you may want to create and activate a virtual environment (using virtualenv, virtualenvwrapper or conda) before installing the CLI.

Updating both the CLI and the Gigantum Client can be done with the commands below:

  • Update the CLI with pip install -U gigantum;
  • Update Gigantum Client with gigantum update.

Start and Stop Gigantum Client

You can start and stop Gigantum Client by running the following commands in a terminal:

  • To start: gigantum start;
  • To stop: gigantum stop.

Docker Must Be Running

Docker must always be running before you start the Gigantum Client.

Starting Gigantum Client will launch a browser and send you to http://localhost:10000.

When you are finished and want to shut down Gigantum Client, just make sure to save your work before running the stop command.

Gigantum CLI

A Python command line tool for managing Gigantum.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.