nci.1

   1 .Dd 2016-06-12
   2 .Dt NCI 1
   3 .Os
   4 .Sh NAME
   5 .Nm nci
   6 .Nd Interact with Canvas installations
   7 .Sh DESCRIPTION
   8 The
   9 .Nm
  10 suite allows interaction with Canvas installations.
  11 .Sh FILES
  12 All
  13 .Nm
  14 programs need to know the url of the Canvas installation they will
  15 connect to, and authentication to perform actions as the proper
  16 user. For this, two files are used.
  17 .Pp
  18 .Bl -tag -width Ds
  19 .It ${XDG_CONFIG_HOME}/nci/site
  20 This text file should contain exactly one line, which will be treated
  21 as a base url.
  22 .It ${XDG_CONFIG_HOME}/nci/token
  23 This text file should contain exactly one line, which will be read as
  24 an access token. For details, see
  25 .Sx ACCESS TOKENS .
  26 .El
  27 .Sh ACCESS TOKENS
  28 Third party programs
  29 .Po like
  30 .Nm
  31 .Pc
  32 authenticate themselves to Canvas be means of
  33 .Ql Access Tokens .
  34 The standard way for an application to acquire an access token is to
  35 register with Instructure and perform the OAuth2 dance. This, however,
  36 is a huge pain in the neck, and it is not entirely clear that all
  37 Canvas-using entities have set up OAuth2. Therefore,
  38 .Nm
  39 uses another method: manual user generation of access tokens. In a web
  40 browser, while logged into Canvas, go to
  41 .Pp
  42 .D1 Account > Settings > New Access Token
  43 .Pp
  44 and follow the directions to create an access token. It is recommended
  45 that you set an expiration date for the token. Write the generated
  46 token to ${XDG_CONFIG_HOME}/nci/token. This token should be treated
  47 as a password: if a malicious entity acquires the token, tney will be
  48 able perform actions with your credentials on Canvas.
  49 .Pp
  50 .Sh SEE ALSO
  51 .Xr nci-create-assignment-group 1
  52 .Xr nci-delete-assignment-group 1
  53 .Xr nci-edit-assignment-group 1
  54 .Xr nci-get-assignment-grades 1
  55 .Xr nci-put-assignment-grades 1
  56 .Xr nci-list-assignments 1
  57 .Xr nci-list-courses 1