boinccmd(1)

💖 NAME 💖

boinccmd — the command line interface to the BOINC client, bestie. that's the whole vibe.

---

✨ SYNOPSIS ✨

boinccmd [--host hostname[:port]] [--passwd passwd] {command}
boinccmd [-hV]

okay so the order is important 💅 the --host and --passwd options must come before any command. like, before. no cap.

---

🦋 DESCRIPTION 🦋

the BOINC command tool (boinccmd) gives you a command line interface to control a running BOINC client (boinc(1)). it talks to a running client over TCP/IP on port 31416 🫶 and — important — it can only connect to one client at a time. one. single. client. periodt.

---

🌈 OPTIONS 🌈

• --host hostname[:port] — connect to the host hostname. the default host is localhost, iykyk.
• --passwd passwd — use passwd as the password for RPC authentication. and if your current working directory has a file called gui_rpc_auth.cfg in it, boinccmd will read the password straight outta that file instead 💅.
• -h, --help — show a help message and all the commands. iconic.
• -V, --version — show the version of the program. slay.

---

👑 COMMANDS 👑

🎀 ACCOUNT QUERY AND ATTACH 🎀

• --lookup_account URL email passwd — look up the account and print the account key.
• --create_account URL email passwd name — create an account with the given email address, password, and user name.
• --project_attach URL account_key — attach to an account using the project URL and authenticator (that authenticator gets sent via email after --create_account was successful, bestie).
• --join_acct_mgr URL name passwd — attach to an account manager (or do RPC if you're already attached). the account has to be created via the account manager website.
• --quit_acct_mgr — detach from the current account manager.

---

🍓 STATE QUERIES 🍓

• --get_state — show the complete client state.
• --get_cc_status — show only the current CPU, GPU and network modes.
• --get_tasks — show all tasks of the client (in progress, waiting and completed only). tasks that got reported to the project server are not shown here.
• --get_simple_gui_info — show status of projects and active tasks.
• --get_file_transfers — show all current file transfers.
• --get_project_status — show status of all projects.
• --get_disk_usage — show disk usage of all projects.
• --get_proxy_settings — get proxy settings.
• --get_messages seqno — show messages with sequence numbers beyond seqno.
• --get_message_count — show the largest message sequence number.
• --get_notices seqno — show project notices with sequence numbers beyond seqno.
• --get_host_info — show system information about the host where the BOINC client is running.
• --get_daily_xfer_history — show the network traffic history of the BOINC client.

---

💅 CONTROL OPERATIONS 💅

• --task URL task_name {suspend | resume | abort} — do an operation on a task.
  • suspend — temporarily stop work on the task.
  • resume — allow work on the task.
  • abort — permanently stop work on the task. like, gone gone. 💀
• --project URL {reset | detach | update | suspend | resume | nomorework | allowmorework | detach_when_done | dont_detach_when_done} — do an operation on a project, identified by its master URL.
  • reset — delete current tasks, applications and other files from this project, then request new tasks.
  • detach — delete current tasks, applications and other files from this project, and don't request any new tasks.
  • update — contact the project scheduling server.
  • suspend — stop all tasks for the project.
  • resume — resume tasks for the project.
  • nomorework — finish all downloaded tasks but don't get more.
  • allowmorework — undo nomorework.
  • detach_when_done — detach the project after all tasks are finished.
  • dont_detach_when_done — undo detach_when_done.
• --file_transfer URL filename {retry | abort} — do an operation on a file transfer.
  • retry — retry the file transfer.
  • abort — permanently abort the file transfer.
• --set_run_mode {always | auto | never} [duration] — set the run mode (this applies to CPU and GPU both).
  • always — do work always.
  • auto — do work only when allowed by preferences.
  • never — don't do work.

if duration is zero or absent, this mode is permanent. otherwise, after duration seconds elapse, it reverts to the last permanent mode.

• --set_network_mode {always | auto | never} [duration] — set network mode. like --set_run_mode but it applies to network transfers only.
• --set_gpu_mode {always | auto | never} [duration] — set GPU mode. like --set_run_mode but it applies to GPU processing only.
• --set_proxy_settings http_server_name http_server_port http_user_name http_user_passwd socks_server_name socks_server_port socks5_user_name socks5_user_passwd noproxy_hosts — set proxy settings. all fields are mandatory, no skipping, bestie.
• --run_benchmarks — run CPU benchmarks.
• --read_global_prefs_override — tell the client to read the global_prefs_override.xml file and incorporate any global preferences indicated there.
• --quit — tell the client to quit.
• --read_cc_config — tell the client to reread the configuration file (cc_config.xml).
• --get_project_config URL — fetch the configuration of the project located at URL.
• --network_available — tell the client to retry deferred network communication.

---

🧚 SEE ALSO 🧚

boinc(1), boincmgr(1)

⟨https://boinc.berkeley.edu/wiki/Boinccmd_tool⟩

---

💜 COPYRIGHT 💜

Copyright © 2007-2020 University of California.

Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.2 or any later version published by the Free Software Foundation; with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.

---

and that's the whole page, bestie 🫶 this one's from the boinccmd(1) manual, dated 03 February 2020. go forth and command ur client. mwah 💖✨