⏱ 2 mins remaining


Learn how the Java SDK works


There are various CLIs (command-line interfaces) that uses the Java SDK to interact with a secondary server.


To run the CLIs:

  1. Edit settings in at_client/src/main/resources/config.yaml
  2. cd to at_java/at_client and run mvn install
  3. Run java -cp "target/client-1.0-SNAPSHOT.jar:target/lib/*" org.atsign.client.cli.<CLI> <args>. Replace “<CLI>” with one of the CLIs (Register, Get, Scan,…) and “<args>” with

List of CLIs

If you want to interact with the atProtocol through a command-line experience, see our CLIs in src/main/java/org/atsign/client/cli/. Note that to use some CLIs, you must have the keys in a keys/ directory in the root project.

  • Delete - delete AtKeys that you’ve shared with another atSign
  • Get - get AtKeys that you’ve shared with another atSign
  • Onboard - authenticate with CRAM and generate your PKI keypair
  • Register - register an atSign (uses Onboard CLI)
  • Scan - see what keys you have and view metadata
  • Share - share an AtKey with another atSign
  • REPL - use raw atProtocol
Registerto claim a free atsign. Requires one-time-password received on the provided email to validate. Registers the free atsign to provided email.email
Onboardutility which ‘onboards’ a new atSign. Once onboarding is complete it creates the all-important keys file. Onboard is a subset of RegisterrootUrl, atSign, cramSecret
Shareshare something with another atSignrootUrl, your AtSign, other AtSign, keyName to share, including namespace, keyValue to share, a string, ttr,
Getget something that was shared by another atSignrootUrl, your AtSign, other AtSign, name of shared key, including namespace,
Deletedelete something that was previously sharedrootUrl, other atSign, name of shared key including namespace
Scanfor seeing what keys exist in the secondary and view metadatarootUrl, atSign, verbose true or false, scan regex
REPLuse raw atProtocol, handles PKAM authrootUrl, atSign, seeEncryptedNotifications true or false