01
Clone the repository.
macOS / Linux
$ git clone https://github.com/Quantify-Terminal/qt.git
$ cd qt
01 / Documentation
Setup and Command Guide█
Use this page to install from source, run the terminal, and review command syntax.
02 / Quick Start
Build and run in five steps.
02
Checkout the release commit.
release_commit.txt
$ git checkout f1b3f1803
Configure and build with CMake.
setup.sh
$ cmake -B build -DCMAKE_BUILD_TYPE=Release
$ cmake --build build04
Run the terminal binary.
run_terminal.sh
$ ./build/bin/quantify-terminal05
Check built-in command help.
terminal_session
> HELP
> HELP COMMANDS
> HELP PYTH
03 / Command Reference
Common commands and syntax.
| Command | Syntax | Description |
|---|---|---|
| GP | RELIANCE:IN EQUITY GP | Returns live price and day summary fields. |
| DES | SBIN:IN EQUITY DES | Opens company description and metadata panel. |
| HP | NIFTY:IN INDEX HP 1Y | Loads historical chart data for selected period. |
| PORT | PORT OVERVIEW | Shows current holdings and aggregated P&L. |
| RISK | PORT RISK VAR | Runs VaR and drawdown checks on current portfolio. |
| PYTH | PYTH OPEN | Starts the embedded Python interpreter. |
| HELP | HELP [COMMAND] | Displays syntax examples and command notes. |
04 / Developer Notes
Reference points for contributors.
Setup Checklist
Toolchain requirements, Qt setup, and source build commands for first-time contributors.
Command Grammar
Token structure and common command patterns used by market, chart, and risk modules.
Scripting Entry
Python entry points for data retrieval, indicator calculation, and workspace helpers.
05 / FAQ
Common setup and usage questions.
Yes. The project is released under the MIT License, which allows personal and commercial use under standard license terms.
The default adapters cover NSE and public feed integrations, and additional providers can be added through the adapter layer.
Run PYTH OPEN inside the terminal session and the embedded interpreter will open with access to terminal APIs.
Yes. You can submit pull requests for documentation, examples, and setup instructions through the public repository.
Open an issue in the GitHub repository with your OS, compiler version, and the build log so maintainers can reproduce the problem.