hips-provider is one program with two roles. The daemon runs as the system service, started at boot under its own service account. Every other command is a client: run in a terminal, on the computer or over SSH, it talks to the daemon over its local socket (a named pipe on Windows) and holds no key, certificate or token. With no command it opens the terminal view.
JSON for scripts, one object per line, on every command that answers with facts
--plain
Plain text, one fact per line, no boxes or color: for a screen reader, a log or a script. Output into a pipe is plain already
--color <when>
Color: auto lets the terminal and NO_COLOR decide (the default), always keeps it even into a pipe, and "never" turns it off
--socket <path>
The daemon's socket or named pipe, when it is not at the system path; also HIPS_PROVIDER_SOCKET
--version, --help
The version, or the help of a command
Option
--json
What it does
JSON for scripts, one object per line, on every command that answers with facts
Option
--plain
What it does
Plain text, one fact per line, no boxes or color: for a screen reader, a log or a script. Output into a pipe is plain already
Option
--color <when>
What it does
Color: auto lets the terminal and NO_COLOR decide (the default), always keeps it even into a pipe, and "never" turns it off
Option
--socket <path>
What it does
The daemon's socket or named pipe, when it is not at the system path; also HIPS_PROVIDER_SOCKET
Option
--version, --help
What it does
The version, or the help of a command
See what the computer is doing
Command
What it does
hips-provider view
The terminal view: live status, the level and its reasons, telemetry, the current job, and every setting. The default with no command
hips-provider status
This computer's sheet, printed once. --watch (or --live) keeps it current until q, with charts of the last 10 minutes; into a pipe, a line at each change
hips-provider history
The work this computer recorded itself, day by day: GPU time, jobs, models, the hours it was available. --days N (-d), today included, from 1 to 35, 10 by default; --watch reads it again every minute. Earnings are the Console's
hips-provider gpus
Each GPU of the machine as its own unit: its state, whether HIPS is still checking it, and its settings that differ from the machine's. --watch keeps it current each second; --dismiss <gpu> dismisses the notice of a new GPU
Command
hips-provider view
What it does
The terminal view: live status, the level and its reasons, telemetry, the current job, and every setting. The default with no command
Command
hips-provider status
What it does
This computer's sheet, printed once. --watch (or --live) keeps it current until q, with charts of the last 10 minutes; into a pipe, a line at each change
Command
hips-provider history
What it does
The work this computer recorded itself, day by day: GPU time, jobs, models, the hours it was available. --days N (-d), today included, from 1 to 35, 10 by default; --watch reads it again every minute. Earnings are the Console's
Command
hips-provider gpus
What it does
Each GPU of the machine as its own unit: its state, whether HIPS is still checking it, and its settings that differ from the machine's. --watch keeps it current each second; --dismiss <gpu> dismisses the notice of a new GPU
A GPU is named by its index, its UUID or the first part of its UUID, as hips-provider gpus lists them, wherever a command takes <gpu>.
Set up and connect
Command
What it does
hips-provider setup
The guided first run: finds the GPUs, the engines and the idle monitor, starts the service (installing it where it must), links the computer to your account and says what runs next. --yes takes the recommended answer to every question; --mode auto|always sets the mode (also HIPS_MODE)
hips-provider connect
Links the computer to an account: shows the code, a QR code and the address to approve it in the Console
Command
hips-provider setup
What it does
The guided first run: finds the GPUs, the engines and the idle monitor, starts the service (installing it where it must), links the computer to your account and says what runs next. --yes takes the recommended answer to every question; --mode auto|always sets the mode (also HIPS_MODE)
Command
hips-provider connect
What it does
Links the computer to an account: shows the code, a QR code and the address to approve it in the Console
Both take an enrollment code instead of an approval, for a server joining a provider's fleet with nobody approving it: --enrollment-code-file <file> reads it from a file only root or you can read (mode 0600 or 0400, not a link), and --enrollment-code-stdin reads it piped in on standard input, so it is never typed as an argument. Providers create codes in the Console's Connect many machines, which arrives with the next Console release.
Exit code
From setup and connect
0
Done
1
Failed, HIPS not reached among them; it may be tried again
2
The enrollment code could not be read: none given, a file others can read, or not a code
3
This machine has no GPU HIPS supports
4
HIPS refused the enrollment code: used up, expired, revoked or unknown
130
Stopped before it finished; the daemon goes on
Exit code
0
From setup and connect
Done
Exit code
1
From setup and connect
Failed, HIPS not reached among them; it may be tried again
Exit code
2
From setup and connect
The enrollment code could not be read: none given, a file others can read, or not a code
Exit code
3
From setup and connect
This machine has no GPU HIPS supports
Exit code
4
From setup and connect
HIPS refused the enrollment code: used up, expired, revoked or unknown
Exit code
130
From setup and connect
Stopped before it finished; the daemon goes on
Pause and resume
Command
What it does
hips-provider pause
Stops new work; a running job drains. --for 30m, --for 1h or --for 8h for a duration, --until 18:00 or --until tomorrow for a local time, neither for until resumed. Pausing while paused changes the end
hips-provider pause --gpu <gpu>
Pauses one GPU alone; the others work on
hips-provider pause --wait
Returns only once the running work has finished and the GPU's memory is free, so the GPU can be handed over at that moment; --timeout 5m sets the longest wait
hips-provider resume
Ends the pause; --gpu <gpu> ends one GPU's pause alone
Command
hips-provider pause
What it does
Stops new work; a running job drains. --for 30m, --for 1h or --for 8h for a duration, --until 18:00 or --until tomorrow for a local time, neither for until resumed. Pausing while paused changes the end
Command
hips-provider pause --gpu <gpu>
What it does
Pauses one GPU alone; the others work on
Command
hips-provider pause --wait
What it does
Returns only once the running work has finished and the GPU's memory is free, so the GPU can be handed over at that moment; --timeout 5m sets the longest wait
Command
hips-provider resume
What it does
Ends the pause; --gpu <gpu> ends one GPU's pause alone
On a computer a pause also ends when the computer restarts. On a server with the data-center flag it lasts through restarts until resumed, and --reason <text> (at most 200 characters) says why in the status and in the Console; on a computer without the flag --reason is refused and nothing is paused.
Exit code
From pause
From resume
0
Paused, and drained with --wait
Resumed, or not paused ("Not paused.")
1
Another failure
2
A usage error
69
The service is not running
The service is not running
75
--timeout passed first; still paused
77
This account may not
This account may not
Exit code
0
From pause
Paused, and drained with --wait
From resume
Resumed, or not paused ("Not paused.")
Exit code
1
From pause
Another failure
From resume
Exit code
2
From pause
A usage error
From resume
Exit code
69
From pause
The service is not running
From resume
The service is not running
Exit code
75
From pause
--timeout passed first; still paused
From resume
Exit code
77
From pause
This account may not
From resume
This account may not
Settings and the minimum price
Command
What it does
hips-provider config get [name]
One setting, or every setting with its source and revision. --gpu <gpu> shows one GPU's settings with where each value comes from
hips-provider config set <name> <value>
Changes one setting, written through the daemon so it reaches the configuration file and My GPUs. With --gpu <gpu> it sets one GPU's own value of min_price, light_work_at_low, thermal_limits, memory_headroom or excluded_models, and the value machine makes the GPU follow the machine again
hips-provider price
Shows the minimum price
hips-provider price auto
Auto, recommended: HIPS prices from the live market. --offset N places this computer from 50 percent below (-50) to 50 percent above (50) the market, 0 by default
hips-provider price manual <input> <output>
Manual: the lowest price per 1M input and per 1M output tokens, in US dollars with up to 6 decimals, such as 0.05 0.2
hips-provider price account
Follows your account's minimum price, set in the Console
hips-provider price machine --gpu <gpu>
The GPU follows this machine's minimum price again
Command
hips-provider config get [name]
What it does
One setting, or every setting with its source and revision. --gpu <gpu> shows one GPU's settings with where each value comes from
Command
hips-provider config set <name> <value>
What it does
Changes one setting, written through the daemon so it reaches the configuration file and My GPUs. With --gpu <gpu> it sets one GPU's own value of min_price, light_work_at_low, thermal_limits, memory_headroom or excluded_models, and the value machine makes the GPU follow the machine again
Command
hips-provider price
What it does
Shows the minimum price
Command
hips-provider price auto
What it does
Auto, recommended: HIPS prices from the live market. --offset N places this computer from 50 percent below (-50) to 50 percent above (50) the market, 0 by default
Command
hips-provider price manual <input> <output>
What it does
Manual: the lowest price per 1M input and per 1M output tokens, in US dollars with up to 6 decimals, such as 0.05 0.2
Command
hips-provider price account
What it does
Follows your account's minimum price, set in the Console
Command
hips-provider price machine --gpu <gpu>
What it does
The GPU follows this machine's minimum price again
price shows a warning or a note before it saves; --yes saves after showing it, without asking. --gpu <gpu> on price and its subcommands sets one GPU's own price, the third level over the machine's and the account's. Every setting is on the settings reference.
Each model version in the cache: its size, whether an engine uses it now, and whether HIPS's plan keeps it here
hips-provider cache delete <model>
Deletes one model from the cache, --version <version> where it holds more than one. Refused, with why, while an engine uses it or HIPS's plan keeps it; HIPS is told and plans again
Command
hips-provider cache list
What it does
Each model version in the cache: its size, whether an engine uses it now, and whether HIPS's plan keeps it here
Command
hips-provider cache delete <model>
What it does
Deletes one model from the cache, --version <version> where it holds more than one. Refused, with why, while an engine uses it or HIPS's plan keeps it; HIPS is told and plans again
Crash reports, logs and support
Command
What it does
hips-provider crash list
The crash reports queued and sent: time, component, kind, version
hips-provider crash show <id>
One report in full, as the JSON that is or was sent
hips-provider logs [component]
The newest lines of a log: daemon (the default), engine-host, watcher or updater; --lines N, 50 by default
hips-provider support bundle
Gathers the logs, the settings, the device facts, the versions and the crash reports into a zip on this computer, after showing its file list. Nothing is sent to HIPS
Command
hips-provider crash list
What it does
The crash reports queued and sent: time, component, kind, version
Command
hips-provider crash show <id>
What it does
One report in full, as the JSON that is or was sent
Command
hips-provider logs [component]
What it does
The newest lines of a log: daemon (the default), engine-host, watcher or updater; --lines N, 50 by default
Command
hips-provider support bundle
What it does
Gathers the logs, the settings, the device facts, the versions and the crash reports into a zip on this computer, after showing its file list. Nothing is sent to HIPS
support bundle saves to your Downloads folder unless --out <path> names a new file; --list shows the file list and saves nothing; --without-min-price leaves your minimum price out; --remove <part> leaves a part out, by its path in the list, and may be given more than once.
Registers the daemon, the crash watcher and the privileged updater, run as root as the packages do. --headless for a machine with no desktop session, the default on Linux that boots to no graphical target and on DGX OS and Jetson Linux; --desktop for a Linux desktop whatever its default target
hips-provider service uninstall
Removes every service, the files, the state and the service account
hips-provider service start
Starts each service that is stopped; in a container, where systemd does not run, starts the daemon under the app's own supervision
hips-provider service stop
Stops the daemon's service until service start
hips-provider service run
Runs the service in the foreground until it is stopped: a Linux container's own command. On a stop the running work finishes within HIPS_STOP_TIMEOUT less 5 seconds (10 seconds when it is not set), then it ends; a second stop ends it at once
hips-provider service status
Whether the daemon's service runs: exits 0 when it does, 3 when it does not
hips-provider service prerequisites
Installs this Linux machine's GPU prerequisites from the distribution: on an AMD GPU the Vulkan loader and Mesa's Vulkan drivers where missing, and on Strix Halo a kernel with the fixes ROCm needs. Never restarts the computer. --dry-run says what it would install. Exits 0 when nothing more is needed, 3 when a restart of the computer finishes it, 1 when a step failed
Command
hips-provider service install
What it does
Registers the daemon, the crash watcher and the privileged updater, run as root as the packages do. --headless for a machine with no desktop session, the default on Linux that boots to no graphical target and on DGX OS and Jetson Linux; --desktop for a Linux desktop whatever its default target
Command
hips-provider service uninstall
What it does
Removes every service, the files, the state and the service account
Command
hips-provider service start
What it does
Starts each service that is stopped; in a container, where systemd does not run, starts the daemon under the app's own supervision
Command
hips-provider service stop
What it does
Stops the daemon's service until service start
Command
hips-provider service run
What it does
Runs the service in the foreground until it is stopped: a Linux container's own command. On a stop the running work finishes within HIPS_STOP_TIMEOUT less 5 seconds (10 seconds when it is not set), then it ends; a second stop ends it at once
Command
hips-provider service status
What it does
Whether the daemon's service runs: exits 0 when it does, 3 when it does not
Command
hips-provider service prerequisites
What it does
Installs this Linux machine's GPU prerequisites from the distribution: on an AMD GPU the Vulkan loader and Mesa's Vulkan drivers where missing, and on Strix Halo a kernel with the fixes ROCm needs. Never restarts the computer. --dry-run says what it would install. Exits 0 when nothing more is needed, 3 when a restart of the computer finishes it, 1 when a step failed
Two commands are started by the service manager, not by a person: hips-provider daemon, the daemon itself (--foreground for development, --headless for the owner-workload rule), and hips-provider watcher, the crash watcher, which on Linux can start the daemon as its child (--daemon, with --headless, and --user <account> to become the service account first where no service manager sets it, as in a container).
Environment variables
The variables a person sets; an enrollment code's variables are the data-centers guide's
Variable
Read by
What it does
HIPS_PROVIDER_SOCKET
Every command
The daemon's local socket (macOS, Linux) or named pipe (Windows), as --socket names it; the system path otherwise
HIPS_MODE
hips-provider setup, the one-line installer
The mode setup takes without asking, as --mode names it: auto or always
HIPS_PROVIDER_LOG
hips-provider daemon, hips-provider service run
The daemon's log filter, such as debug; the default is info. A container passes it to the daemon it supervises
HIPS_UPDATER_LOG
hips-provider service run
The privileged updater's log filter, such as debug; a container passes it to the updater it supervises
HIPS_STOP_TIMEOUT
hips-provider daemon, hips-provider service run
The seconds a stop gives the service before it is killed, set with the container's or the unit's own stop timeout: running work finishes within it less 5 seconds (10 seconds when it is not set)
HIPS_VERSION, HIPS_NO_LINK, HIPS_DATA_CENTER
The one-line installer
A release other than the newest, installing without linking, and declaring a data-center server; the overview has each
Variable
HIPS_PROVIDER_SOCKET
Read by
Every command
What it does
The daemon's local socket (macOS, Linux) or named pipe (Windows), as --socket names it; the system path otherwise
Variable
HIPS_MODE
Read by
hips-provider setup, the one-line installer
What it does
The mode setup takes without asking, as --mode names it: auto or always
Variable
HIPS_PROVIDER_LOG
Read by
hips-provider daemon, hips-provider service run
What it does
The daemon's log filter, such as debug; the default is info. A container passes it to the daemon it supervises
Variable
HIPS_UPDATER_LOG
Read by
hips-provider service run
What it does
The privileged updater's log filter, such as debug; a container passes it to the updater it supervises
Variable
HIPS_STOP_TIMEOUT
Read by
hips-provider daemon, hips-provider service run
What it does
The seconds a stop gives the service before it is killed, set with the container's or the unit's own stop timeout: running work finishes within it less 5 seconds (10 seconds when it is not set)
Variable
HIPS_VERSION, HIPS_NO_LINK, HIPS_DATA_CENTER
Read by
The one-line installer
What it does
A release other than the newest, installing without linking, and declaring a data-center server; the overview has each
Remove
hips-provider remove removes HIPS Provider from this computer: work stops, the model cache and the crash queue are deleted, and the updater removes the rest. Remove the device in My GPUs as well, which revokes its certificates.
