Run pfeed <command> --help for the full details of any command.
pfeed download¶ pfeed download SOURCE PRODUCT RESOLUTION [OPTIONS]Option Description Default --startFirst date (inclusive), YYYY-MM-DD --endLast date (inclusive), YYYY-MM-DD yesterday (UTC) --rollbackHow far to roll back from today (UTC) when --start is not given, e.g. 7d, ytd, max 1d--layerData layer to store the data in: raw or cleaned cleaned--ioWhere and how to store the data: parquet or ducklake parquet--pathDirectory to store the data under pfeed’s data path--originSub-label for data from the same source but different origins
pfeed download bybit BTC_USDT_PERP 1m --start 2025-01-01 --end 2025-01-31
pfeed download bybit BTC_USDT_PERP 1t --rollback 7d --io ducklakepfeed stream¶ pfeed stream SOURCE PRODUCT RESOLUTION [OPTIONS]Option Description Default --ioWhere and how to store the streamed data: parquet or ducklake not stored --pathDirectory to store the data under (with --io) pfeed’s data path--envTrading environment: paper or live live--originSub-label for data from the same source but different origins --flush-intervalSeconds between writes of the buffered data (with --io) 100--incremental-barsAlso store the updates of a bar before it closes (with --io) --quietDo not print the streamed data
pfeed stream bybit BTC_USDT_PERP 1m
pfeed stream bybit BTC_USDT_PERP 1t --io ducklake --quietpfeed data¶ pfeed data PATH [OPTIONS]Option Description Default --keepKeep the notebook after exit deleted on exit --portPort of the data explorer a free port --data-pathOverride the data path pfeed’s data path
pfeed data ducklake # the DuckLake tables stored by pfeed
pfeed data parquet # the Parquet files stored by pfeed
pfeed data ~/Downloads/trades.parquet --keepPATH can be a Parquet, DuckDB, DuckLake or SQLite file, a folder of Parquet files, or a DuckLake folder; the type is detected automatically. A relative PATH is resolved against the data path, so ducklake above means ~/.pfeed/data/ducklake.
pfeed ducklake¶ pfeed ducklake [OPTIONS] COMMANDOption Description Default --base-pathDuckLake directory to maintain <data_path>/ducklake
Command Description optimizeCompact all tables into fewer, larger Parquet files to speed up reads vacuumDelete history older than the retention period (--retention-hours, default 168). Dry run by default; add --no-dry-run (-n) to actually delete
pfeed ducklake optimize
pfeed ducklake vacuum --no-dry-runpfeed config¶ Command Description listPrint the config and the config file’s path wherePrint the config directory setChange the data path (--data) or log path (--log) openOpen the config file (-c) or logging.yaml (-l) in your editor resetReset the config file (-c) or logging.yaml (-l) to defaults, all of them if no flag is given
See Configuration for details.
pfeed remove¶ Alias: pfeed rm
Command Description data [TARGET]Remove a file/folder under the data path, or empty it if no TARGET is given log [TARGET]Remove a file/folder under the log path, or empty it if no TARGET is given
Asks for confirmation first; add -y to skip it.
pfeed rm data some_folderpfund-shell¶ pfeed comes with pfund-shell, an interactive shell that brings together the commands of every installed package in the PFund ecosystem (e.g. pfeed, pfund) in one place, with autocompletion: