4 title: "Reference: Command line SDK"
8 h1. Reference: Command line SDK
10 If you are logged in to an Arvados VM, the command line SDK should be installed. Try:
14 <!-- _Help is not helpful. See bug #1667_ -->
18 Set the ARVADOS_API_HOST environment variable.
20 @export ARVADOS_API_HOST={{ site.arvados_api_host }}@
22 Log in to Workbench and get an API token for your account. Set the ARVADOS_API_TOKEN environment variable.
25 ARVADOS_API_TOKEN=c0vdbi8wp7f703lbthyadlvmaivgldxssy3l32isslmax93k9@
27 If you are using a development instance with an unverifiable SSL certificate, set the ARVADOS_API_HOST_INSECURE environment variable.
29 @export ARVADOS_API_HOST_INSECURE=1@
31 <!-- _This should link back to "api-tokens":api-tokens.html instead of
32 re-explaining it__ -->
36 @arv [global_options] resource_type resource_method [method_parameters]@
38 <!-- _This is what arv --help really ought to print out_ -->
42 Get UUID of the current user
45 Get entire record (json) for current user
48 Get entire record for identified user
49 @arv -h user get --uuid 6dnxa-tpzed-iimd25zhzh84gbk@
52 @arv user update --uuid 6dnxa-tpzed-iimd25zhzh84gbk --first-name "Bob"@
54 Get list of groups (showing just UUIDs)
57 Get list of groups (showing entire records)
62 <!-- _Move these up to before "basic examples", and give examples of what
63 these options do and how they might be useful._ -->
65 - @--json@, @-j@ := Output entire response as compact JSON.
67 - @--pretty@, @--human@, @-h@ := Output entire response as JSON with whitespace for better human-readability.
69 - @--uuid@ := Output only the UUIDs of object(s) in the API response, one per line.
71 h3. Resource types and methods
73 Get list of resource types
76 Get list of resource methods for the "user" resource type