Skip to content

README.md

Latest commit

 

History

History
74 lines (49 loc) · 1.58 KB

README.md

File metadata and controls

74 lines (49 loc) · 1.58 KB

Qortium CLI Startup Guide

1) Prerequisites

  • Python 3.10+ installed
  • A running Qortium/Qortal node API (default expected endpoint: http://127.0.0.1:24891)

2) Install

Linux/macOS

python3 -m pip install --user pipx
python3 -m pipx ensurepath
pipx install "git+https://github.com/<org>/<repo>.git"

Windows

py -m pip install --user pipx
py -m pipx ensurepath
pipx install "git+https://github.com/<org>/<repo>.git"

3) Start The App

qortium-cli

4) First-Run Setup Flow

On first launch, setup asks for:

  1. Endpoint URL (default: http://127.0.0.1:24891)
  2. Timeout seconds
  3. API key
  4. Key mode: private key
  5. Key mode: seed phrase (the app derives the private key)

Then it auto-fills:

  • public key
  • account address
  • display name (primary name if available)

5) Runtime Settings Files

The app writes runtime settings here:

  • Linux/macOS: ~/.qortium-cli
  • Windows: %APPDATA%\QortiumCLI

Files created:

  • endpoint.py
  • config.py
  • chat_settings.json

Optional custom location:

  • set QOTIUM_CLI_HOME=/path/to/folder before launch

6) Reconfigure Or Reset

  • In the app, choose menu option 9 to re-run setup.
  • Or delete the runtime settings files above and launch again.

7) Startup Troubleshooting

  • qortium-cli: command not found: open a new terminal after pipx ensurepath, or add pipx bin dir to PATH.
  • Cannot reach node/API: verify your node is running and listening on 127.0.0.1:24891.
  • API key prompt blocks setup: enter a valid X-API-KEY (or press Enter to keep current during reconfigure).