foxden

foxden CLI

foxden Command Line Interface (CLI) provides an uniform interface to all FOXDEN services. Its usage, commands and examples can be fetched as following:

./foxden -h
foxden command line tool
Complete documentation at https://chesscomputing.github.io/FOXDEN/

Usage:
  foxden [command]

Available Commands:
  completion  Generate the autocompletion script for the specified shell
  config      foxden config commamd
  describe    foxden describe command
  doi         foxden doi command
  help        Help about any command
  mc          foxden MaterialsCommons commands
  meta        foxden MetaData commands
  ml          foxden ml commands
  prov        foxden provenance commands
  s3          foxden s3 commands
  search      foxden search commands
  spec        foxden SpecScans commands
  sync        foxden sync command
  token       foxden token commands
  version     foxden version commamd
  view        foxden view commands

Flags:
      --config string   config file (default is $HOME/.foxden.yaml)
  -h, --help            help for foxden
      --verbose int     verbosity level)

Use "foxden [command] --help" for more information about a command.

Each command has its own documentation section along with necessary examples, e.g.

./foxden meta --help
foxden MetaData commands to access FOXDEN MetaData service
Complete documentation at https://chesscomputing.github.io/FOXDEN/

foxden meta <ls|rm|view> [options]
foxden meta add <file.json> {options}
options: --schema=<schema> --did-attrs=<attrs> --did-sep=<separator> --did-div=<divider> --json

Examples:

# list all meta data records:
foxden meta ls

# list specific meta-data record:
foxden meta view <DID>

# remove meta-data record:
foxden meta rm 123xyz

# add meta-data record with given schema, file and did attributes which create a did value:
foxden meta add <file.json> --schema=<schema> --did-attrs=beamline,btr,cycle,sample_name --did-sep=/ --did-div==

# the same as above since it is default values
foxden meta add <file.json> --schema=<schema>

# the same as above but provide json output
foxden meta add <file.json> --schema=<schema> --json

Trusted client

The foxden CLI supports trusted client. In order to use this feature the FOXDEN server should be properly configured with trusted client info. Here is appropriate configuration section:

TrustedUsers:
  - user: "trusted node user name"
    ip: "trusted node ip address"
    mac: "trusted node mac address"

Once, configured you may use foxden CLI to perform action on behalf of trusted user of specific node. For that you only need to use FOXDEN_TRUSTED_CLIENT=1 env variable on trusted node under your trusted user account, e.g.

# request a token with read and write scope
FOXDEN_TRUSTED_CLIENT=1 foxden token create read+write

# view token assigned to variable t
foxden token view --token=$t

AccessToken  :  eyJh...
Issuer       :  CHESS Authz server
User         :  abc
Token Scope  :  read+write
Kind         :  trusted_client
Groups       :  []
Scopes       :  []
ExpiresAt    :  2026-08-25 11:45:21 -0400 EDT

# or even perform actions with meta data records
foxden meta ls