Skip to main content

:::note Generated reference Generated from honeyframeapi 0.1.8 — do not edit by hand. :::

honeyframeapi.cli

honeyframe — a thin CLI over the SDK for shell use.

Reads connection + credentials from the environment (same vars as HoneyframeClient.from_env): HONEYFRAME_URL, HONEYFRAME_TOKEN (an hf_… PAT or a JWT), or HONEYFRAME_USERNAME/HONEYFRAME_PASSWORD, plus optional HONEYFRAME_PROJECT_ID. The org is chosen with -o/--org. Flags override env. To pass a token explicitly without exposing it in ps or shell history, use --token-file PATH or --token - (read from stdin); a literal --token VALUE still works but warns.

Examples

export HONEYFRAME_URL=https://platform.your-domain.com
export HONEYFRAME_TOKEN=hf_…
honeyframe whoami
honeyframe projects
honeyframe datasets -p 1
honeyframe sql "SELECT COUNT(*) FROM marts.fact_orders" -p 1 -f csv
honeyframe pat create --name laptop --expires-days 90
honeyframe scenario run daily_pipeline -p 1 --wait

Flags go after the subcommand (kubectl/gh style): honeyframe <cmd> [flags].

Functions​

cmd_whoami()​

cmd_whoami(c, args)

cmd_version()​

cmd_version(c, args)

cmd_projects()​

cmd_projects(c, args)

cmd_datasets()​

cmd_datasets(c, args)

cmd_sql()​

cmd_sql(c, args)

cmd_pat_create()​

cmd_pat_create(c, args)

cmd_pat_list()​

cmd_pat_list(c, args)

cmd_pat_revoke()​

cmd_pat_revoke(c, args)

cmd_scenario_list()​

cmd_scenario_list(c, args)

cmd_scenario_run()​

cmd_scenario_run(c, args)

cmd_engine()​

cmd_engine(c, args)

cmd_lineage()​

cmd_lineage(c, args)

cmd_upload()​

cmd_upload(c, args)

cmd_export()​

cmd_export(c, args)

cmd_plugin_init()​

cmd_plugin_init(args) -> int

cmd_plugin_check()​

cmd_plugin_check(args) -> int

cmd_plugin_run()​

cmd_plugin_run(args) -> int

cmd_plugin_pack()​

cmd_plugin_pack(args) -> int

build_parser()​

build_parser() -> argparse.ArgumentParser

main()​

main(argv=None) -> int

Verified against honeyframeapi 0.1.8.