US Crowding Radar
Use the tested Python CLI in this repository. Do not reimplement scoring or call undocumented interfaces directly.
Safety
- This is read-only market intelligence, not trade execution.
- Never request, print, log, or place
CLAWBY_API_KEYin command arguments. - The dashboard accepts the key through its local UI, validates it against Clawby's official
/api/accountendpoint, and may save it to the Git-ignored local credential file with mode600. - CLI automation reads the key only from the environment or the ignored
.envfile. - Never describe the crowding score as a price forecast or investment advice.
Commands
From the repository root:
python3 -m us_crowding_radar doctor
python3 -m us_crowding_radar watchlist list
python3 -m us_crowding_radar watchlist add TICKER --label "Company"
python3 -m us_crowding_radar watchlist remove TICKER
python3 -m us_crowding_radar scan
python3 -m us_crowding_radar scan --refresh
python3 -m us_crowding_radar scan --notify
python3 -m us_crowding_radar serve --port 8786
Workflow
- For the dashboard, ask the user to enter their own Key in the local UI; never repeat or log it. A successful validation can be restored from the protected local credential file.
- For CLI automation, run
doctorand report only whether the environment key is configured. - Confirm the watchlist before a live scan.
- Use
scanfor a cached authorized read-only run orscan --refreshfor fresh remote data. - Report score, direction, coverage, component evidence, source timestamps, and failed dimensions together.
- Only use
--notifywhen the user has configured and authorized the notification target.
Validation
python3 -m unittest discover -s tests -v
node --check us_crowding_radar/web/app.js
python3 -m compileall -q us_crowding_radar