---
name: "boinccmd"
section: "1"
platform: "linux"
package: "boinc-client"
version: "8.0.4+dfsg-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/boinccmd"
---

# boinccmd(1)

The command line interface to the BOINC client.

## NAME

boinccmd - The command line interface to the BOINC client.

## SYNOPSIS

FC**boinccmd**F\[0\]  \[FC**--host**F\[0\] *hostname*\[:*port*\]\] \[FC**--passwd**F\[0\] *passwd*\] {*command*} FC**boinccmd**F\[0\]  \[FC**-hV**F\[0\]\]

Notice that the order of the options is important. The FC**--host**F\[0\] and FC**--passwd**F\[0\] options must precede any command.

## DESCRIPTION

The BOINC command tool (**boinccmd**) provides a command line interface to control a running BOINC client ([**boinc**(1)](/boinc/1.md)). It communicates with a running client using port 31416 over TCP/IP. It can only connect to one client at a time.

## OPTIONS

- FC**--host**F\[0\] *hostname*\[:*port*\]

  Connect to the host *hostname*. The default host is localhost.

- FC**--passwd**F\[0\] *passwd*

  Use *passwd* as password for RPC authentication. If the current working directory contains a file FC*gui\_rpc\_auth.cfg*F\[0\], **boinccmd** will read the password from this file.

- FC**-h**F\[0\], FC**--help**F\[0\]

  Show a help message and all commands.

- FC**-V**F\[0\], FC**--version**F\[0\]

  Show the version of the program.

## COMMANDS

### ACCOUNT QUERY AND ATTACH

- FC**--lookup\_account**F\[0\] *URL* *email* *passwd*

  Look up account and print account key.

- FC**--create\_account**F\[0\] *URL* *email* *passwd* *name*

  Create account with the given email address, password, and user name.

- FC**--project\_attach**F\[0\] *URL* *account\_key*

  Attach to an account using the project URL and authenticator (sent via email after FC**--create\_account**F\[0\] was successful).

- FC**--join\_acct\_mgr**F\[0\] *URL* *name* *passwd*

  Attach to an account manager (or do RPC if already attached). The account has to be created via the account manager website.

- FC**--quit\_acct\_mgr**F\[0\]

  Detach from the current account manager.

### STATE QUERIES

- FC**--get\_state**F\[0\]

  Show complete client state.

- FC**--get\_cc\_status**F\[0\]

  Show only current CPU, GPU and network modes.

- FC**--get\_tasks**F\[0\]

  Show all tasks of the client (in progress, waiting and completed only). Tasks that where reported to the project server are not shown here.

- FC**--get\_simple\_gui\_info**F\[0\]

  Show status of projects and active tasks.

- FC**--get\_file\_transfers**F\[0\]

  Show all current file transfers.

- FC**--get\_project\_status**F\[0\]

  Show status of all projects.

- FC**--get\_disk\_usage**F\[0\]

  Show disk usage of all projects.

- FC**--get\_proxy\_settings**F\[0\]

  Get proxy settings.

- FC**--get\_messages**F\[0\] *seqno*

  Show messages with sequence numbers beyond *seqno*.

- FC**--get\_message\_count**F\[0\]

  Show largest message sequence number.

- FC**--get\_notices**F\[0\] *seqno*

  Show project notices with sequence numbers beyond *seqno*.

- FC**--get\_host\_info**F\[0\]

  Show system information about the host where the BOINC client is running.

- FC**--get\_daily\_xfer\_history**F\[0\]

  Show network traffic history of the BOINC client.

### CONTROL OPERATIONS

- FC**--task**F\[0\] *URL* *task\_name* {suspend \| resume \| abort}

  Do operation on a task.

  - FC**suspend**F\[0\]

    Temporarily stop work on task.

  - FC**resume**F\[0\]

    Allow work on task.

  - FC**abort**F\[0\]

    Permanently stop work on task.

- FC**--project**F\[0\] *URL* {reset \| detach \| update \| suspend \| resume \| nomorework \| allowmorework \| detach\_when\_done \| dont\_detach\_when\_done}

  Do operation on a project, identified by its master URL.

  - FC**reset**F\[0\]

    Delete current tasks, applications and other files from this project, request new tasks.

  - FC**detach**F\[0\]

    Delete current tasks applications and other files from this project, don't request any new tasks.

  - FC**update**F\[0\]

    Contact project scheduling server.

  - FC**suspend**F\[0\]

    Stop all tasks for project.

  - FC**resume**F\[0\]

    Resume tasks for project.

  - FC**nomorework**F\[0\]

    Finish all downloaded tasks but don't get more.

  - FC**allowmorework**F\[0\]

    Undo FC**nomorework**F\[0\].

  - FC**detach\_when\_done**F\[0\]

    Detach project after all tasks are finished.

  - FC**dont\_detach\_when\_done**F\[0\]

    Undo FC**detach\_when\_done**F\[0\].

- FC**--file\_transfer**F\[0\] *URL* *filename* {retry \| abort}

  Do operation on a file transfer.

  - FC**retry**F\[0\]

    Retry file transfer.

  - FC**abort**F\[0\]

    Permanently abort file transfer.

- FC**--set\_run\_mode**F\[0\] {always \| auto \| never} \[*duration*\]

  Set run mode (applies to CPU and GPU).

  - FC**always**F\[0\]

    Do work always.

  - FC**auto**F\[0\]

    Do work only when allowed by preferences.

  - FC**never**F\[0\]

    Don't do work.

  If *duration* is zero or absent, this mode is permanent. Otherwise, after *duration* seconds elapse, revert to last permanent mode.

- FC**--set\_network\_mode**F\[0\] {always \| auto \| never} \[*duration*\]

  Set network mode. Like FC**--set\_run\_mode**F\[0\] but applies to network transfers only.

- FC**--set\_gpu\_mode**F\[0\] {always \| auto \| never} \[*duration*\]

  Set GPU mode. Like FC**--set\_run\_mode**F\[0\] but applies to GPU processing only.

- FC**--set\_proxy\_settings**F\[0\] *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.

- FC**--run\_benchmarks**F\[0\]

  Run CPU benchmarks.

- FC**--read\_global\_prefs\_override**F\[0\]

  Tell the client to read the FC*global\_prefs\_override.xml*F\[0\] file and incorporate any global preferences indicated there.

- FC**--quit**F\[0\]

  Tell the client to quit.

- FC**--read\_cc\_config**F\[0\]

  Tell the client to reread the configuration file (FC*cc\_config.xml*F\[0\]).

- FC**--get\_project\_config**F\[0\] *URL*

  Fetch configuration of project located at *URL*.

- FC**--network\_available**F\[0\]

  Tell the client to retry deferred network communication.

## SEE ALSO

[**boinc**(1)](/boinc/1.md), [**boincmgr**(1)](/boincmgr/1.md)

 ⟨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.