Dockit Docs

Appearance

Dockit TUI ​

Dockit TUI is the terminal companion for the hosted Dockit service. It uses the same backend jobs, validation rules, and entitlement checks as the web product.

What The Current Release Supports ​

  • Authenticated profile lookup through a Dockit CLI token
  • Hosted generation jobs against the same backend used by the web product
  • Local export of generated files into a directory you choose
  • Reuse of the hosted validation and cache path

Current Scope ​

  • The TUI uses the Dockit cloud backend. It is not an offline generator.
  • Generation in the current TUI release requires a Dockit Pro account.
  • Free users can still authenticate, inspect profile status, and prepare for later TUI usage.

Download And Setup ​

  1. Sign in to Dockit at dock-itt.web.app.
  2. Open Settings.
  3. Go to the Dockit TUI section.
  4. Download dockit-tui.zip.
  5. Create a CLI token and copy it before leaving the page.
  6. Extract the ZIP.
  7. On Windows, run run-dockit-tui.cmd. On other platforms, run node dockit-tui.mjs.

Run Requirements ​

  • Node.js 22 or later
  • A valid Dockit CLI token
  • Network access to the hosted Dockit functions

Run The Client ​

Windows:

bat
run-dockit-tui.cmd

Cross-platform:

bash
node dockit-tui.mjs

You can also provide the token through an environment variable:

bash
DOCKIT_CLI_TOKEN=dk_cli_xxx.yyy node dockit-tui.mjs

Optional API override:

bash
DOCKIT_TUI_API_BASE=https://us-central1-dock-itt.cloudfunctions.net/tuiApi node dockit-tui.mjs

Typical Workflow ​

  1. Launch the TUI.
  2. Paste a Dockit CLI token if the client is not already configured.
  3. Review your current profile and plan status.
  4. Choose Generate infrastructure bundle.
  5. Select a preset and answer the generation prompts.
  6. Wait for the async job to finish.
  7. Choose an output directory and let the TUI write the generated files locally.

Token Management ​

  • CLI tokens are created and revoked from Settings > Dockit TUI.
  • Dockit only shows a raw token once at creation time.
  • Revoke a token immediately if a laptop is lost or a shared shell is no longer trusted.

What Gets Written Locally ​

The TUI writes the generated bundle into a target directory you confirm during export. The output mirrors the hosted result bundle and may include files such as:

  • README.md
  • .env.example
  • docker-compose.yml
  • target-specific manifests such as Kubernetes, ECS, or Terraform files
  • workflow or routing files when the selected stack requires them

Notes ​

  • The TUI uses the hosted Dockit backend and current validation rules.
  • If authentication starts failing, create a new CLI token in Settings and replace the stored token.
  • For product usage details beyond the terminal flow, continue with Generator Workflow.

Dockit documentation

Copyright © H-SOFT