CIPHER / Shaw Quant OS

Overview

CIPHER is a command-line research terminal that organizes market prep, watchlists, risk checks, signal review, data pulls, and post-market workflows. The public repository documents the architecture, command taxonomy, configuration boundary, CLI rendering, operator manual, and reliability model of a local quant operating system. It is designed around repeatable daily research workflows rather than automated trading. Broker credentials, account exports, and private logs are intentionally excluded.

Why It Matters

Trading research tools become useful when they reduce friction without hiding assumptions. CIPHER turns common research actions into repeatable commands: prices, movers, indices, technicals, screeners, options checks, macro context, watchlists, reports, and review gates. The goal is operational discipline: consistent market prep, cleaner data pulls, safer credential handling, and auditable research notes.

Core Commands

Command	Purpose
prices	Pull current prices for a configured universe
movers	Review large-cap gainers and losers
indices	Summarize index, volatility, rate, commodity, and crypto context
sectors	Rank sector ETFs by performance
compare	Compare symbols across fundamentals and market features
intraday	Inspect recent intraday bars
ta	Run technical analysis modules
screen	Run momentum, volume, breakout, oversold, and strength screens
opt	Explore option chains and risk filters
macro	Review macro dashboards and rates context
account	Local broker account status, when configured
positions	Local open-position review, when configured
watch	Manage and inspect watchlists
morning	Generate pre-market research brief
eodreport	Generate end-of-day market summary
snapshot	Print a compact single-symbol research view
escheck	Run a behavioral/risk readiness check

Core Features

• Structured command taxonomy for market research
• Local-first configuration and .env credential boundary
• Watchlist, market, technical, options, macro, and reporting workflows
• PowerShell launcher pattern for Windows terminals
• Documentation-first public surface for safe selected components

Architecture

graph TD
  A[CLI Layer] --> B[Data Providers]
  B --> C[Analytics Modules]
  C --> D[Reporting / Logging]
  D --> E[Review Workflow]
  E --> A

Loading

cipher/
  src/cipher/
    cli.py
    commands/
    providers/
    analytics/
    reporting/
    config.py
  scripts/
    cipher.ps1
  examples/
    sample_session.md
  docs/
    command_reference.md
    architecture.md
  tests/
    test_imports.py

Tech Stack

• Python 3.10+
• PowerShell
• pandas, NumPy, Rich
• JSON configuration
• API-based market-data adapters
• Local research tooling patterns where appropriate

Review Docs

• Operator manual
• Reliability model
• Command reference
• Recruiter brief

Quickstart

git clone https://github.com/shawsignaldev/cipher.git
cd cipher
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install -e .
python examples/demo_cli.py

Windows:

git clone https://github.com/shawsignaldev/cipher.git
cd cipher
python -m venv .venv
.venv\Scripts\activate
pip install -r requirements.txt
pip install -e .
python examples\demo_cli.py

Example Terminal Session

$ cipher commands
prices     Show configured universe prices
screen     Run research screeners
macro      Summarize macro context
morning    Build a pre-market research brief
escheck    Run a behavioral/risk readiness gate

Safety

CIPHER is research tooling. It does not provide investment advice, does not guarantee performance, and should not be treated as an automated trading adviser. Any live-data or broker integration must keep credentials local and require user-controlled review.

Project Status

Version 0.1 public research-terminal release with command taxonomy, configuration model, CLI rendering, examples, tests, operator docs, and reliability notes.

Roadmap

• Promote selected local trading-suite utilities into package modules
• Add tested provider interfaces for sample and live-data modes
• Add sanitized report examples
• Add CI for formatting, imports, and command smoke tests

Disclaimer

This repository is for educational and research purposes only. It is not financial advice, investment advice, or a recommendation to buy or sell any security. Trading involves risk, including possible loss of capital.