Developer docs

Uploading your plugin

java -jar sdk/tools/privbot-cli.jar upload, run in your project folder, sends the project's source to PrivBot. PrivBot builds it, runs your tests and the scan, signs it and makes it the version your PrivBot clients install. The command waits for the build and prints every error with what to do about it. You can also upload a zip on the developer page, https://privbot.dev/account/developer.

java -jar sdk/tools/privbot-cli.jar upload [--version X.Y.Z] [--no-activate] [--no-wait] [--dry-run]
                                           [--timeout MINUTES] [--verbose]

The command needs Java 11 or newer. On an older Java it prints The PrivBot command-line tool needs Java 11 or newer., the Java it ran on and how to start it with a newer one, and exits with code 2.

Flag What it does
--version X.Y.Z A check only: the version always comes from <version> in pom.xml, and a different value stops the command.
--no-activate Build without making the new version active. A plugin's first version still activates by itself.
--no-wait Print the build id and stop; follow the build on the developer page. With a version that is already building, only name that build.
--dry-run List what would be uploaded and its size. Nothing is sent, and no sign-in is needed.
--timeout MINUTES How long to follow the build (default 20).
--verbose Print info diagnostics too.

Raise <version> in pom.xml for every new upload: a version that built cannot be uploaded again. A version whose build failed can be uploaded again as it is, and running upload while the version is still building follows that build instead of starting another.

If PrivBot has pulled a plugin, PrivBot clients do not install it, and every new upload of it (here or on the developer page) and every activation of one of its versions is refused; contact PrivBot support if you think that is a mistake.

What is uploaded

Only your source: pom.xml, lombok.config, README.md, README, LICENSE, LICENSE.md and LICENSE.txt from the project folder, and everything under src/. The build service has its own copy of the SDK, so sdk/ and target/ stay at home. Under src/, these are left out:

  • editor, agent and version-control folders (.git, .idea, .vscode, .cursor, .claude, node_modules, ...);
  • binary files (.jar, .class, .dll, .zip, ...): the build compiles your source;
  • files whose name usually holds a secret (.env, *.pem, *.key, *.jks, license.json, credentials*, ...). Java, Kotlin, Groovy and Scala source never counts as one, so Credentials.java is uploaded. A zip uploaded on the developer page gets the same treatment: the build leaves those files out and names them in a PROJECT.SECRETS warning.

Each file left out is named in the output (Not uploaded: ...). The zip may be at most 20 MB, with at most 5 MB per file, 5000 files and 100 MB unpacked (MB here is MiB, 1,048,576 bytes); the command checks all four before it sends anything.

Signing in

The command uses the sign-in the PrivBot launcher keeps on this computer: sign in once with the launcher, as the same Windows user. Nothing is asked for and nothing is saved. If this computer has never run the launcher, upload the project on the developer page instead. Uploading needs an active subscription, on the developer page too.

PrivBot takes only a few uploads at a time. When it is busy the command says so, nothing is uploaded, and the same command works again a minute later.

Upload time limit

An upload must reach PrivBot within 180 seconds. A 20 MB zip therefore needs about 1 Mbit/s of upload speed on the developer page, and about 1.3 Mbit/s from the command, which sends the zip as text (a third larger). A slower upload is cut off: the command and the developer page both say the connection closed before the upload finished, and nothing is uploaded. Try again on a faster connection, or make the project smaller.

Exit codes

Code Meaning
0 Built, and active unless you passed --no-activate; or --dry-run / --no-wait finished.
1 The command line was wrong (an unknown flag, or --version disagrees with pom.xml). Nothing was sent.
2 Anything else: the build failed, the project or sign-in has a problem, or the build is still running. The output says which and what to do.

For an AI agent: a failed build is yours to fix from the diagnostics (the same version can then be uploaded again). A sign-in or subscription problem is the user's to fix: report the message and stop.

Reading a diagnostic

Errors (1):
  src/main/java/com/example/MyNode.java:7  COMPILE
    cannot find symbol
    fix: Check the name and its import.

The first line is where (file:line:column) and the rule (COMPILE, LINT.<rule>, POLICY.<rule>, TEST.<class>, PROJECT.<check>, ...). Then the message, then fix: with what to do instead, when there is advice.

Errors fail the build. Warnings never block your own plugin; a community listing checks again with the strict profile and refuses POLICY warnings.

If you stop the command

The build keeps running on PrivBot's side when the command is interrupted, --timeout passes or the license server stops answering for a while (a few failed checks in a row are retried first). Run upload again to follow it while it is still building; its result, its diagnostics and the Activate button are on the developer page.