Update `identities.md` to reflect current behaviour

finchie
Apr 5, 2024, 9:42 AM
AIYY7K4EOZ5UDAO7HH7JFBW2YGOYPGDRZYFPGGYBF5RYGQ6YVS4QC

Dependencies

  • [2] UAWTPPQX Update documentation on keys/identities
  • [3] NT22VBIW Add key and configuration info

Change contents

  • edit in src/identities.md at line 6
    [3.839]
    [3.839]
    You will need at least 1 identity to record changes, but can have as many as you like, for example `personal`, `school`, and `work`. When Pijul needs to use your identity, it will ask you to choose between them.
  • replacement in src/identities.md at line 11
    [3.860][2.600:1071]()
    Users can generate a new identity using `pijul identity new [name]`. The name used for this identity is not required to bear any relationship to a nest username or SSH identity. During identity generation, users will be asked for a password; on success, the location of the generated key will be displayed to the user (it should be the same directory as your [global configuration](configuration.md)). Pijul currently allows for the generation of one identity at a time.
    [3.860]
    [3.1311]
    Users can generate a new identity using `pijul identity new`. The name used for this identity is not required to bear any relationship to a Nest username or SSH identity. On success, the location of the generated identity will be displayed to the user (it should be in the same directory as your [global configuration](configuration.md)).
    The program will guide you through the following questions:
    | Field | Description | Optional? | Default |
    | ------------- | --------------------------------------------------------------------- | --------- | ------------------------------------ |
    | Identity name | A unique name for your identity | No | `default` |
    | Display name | How Pijul refers to you (e.g. in `pijul log`) | No | OS account name (e.g. "Ferris Crab") |
    | Email | An email address for people to contact | Yes | No (empty) |
    | Encryption | If Pijul should encrypt this identity with a password | Yes | No |
    | Expiry | If this identity should expire by a certain date | Yes | No |
    | Remote | If this identity should be linked to a remote account (e.g. the Nest) | Yes | Yes |
  • replacement in src/identities.md at line 25
    [3.1329][2.1095:1282]()
    `pijul identity prove [options] <remote>` is used to associate an identity with a remote/nest identity. Patches submitted before using `pijul prove` will show only the key as the author.
    [3.1329]
    [3.1505]
    `pijul identity prove [options] <remote>` is used to associate a local identity with a remote (e.g. Nest) account. Patches submitted before proving your identity will show only the key as the author, for example `44hhwRgXtFEeAt6m3KooFCQ5VowqLoQ8YkBP93UZqm9R`. By default, `pijul id new` will do this for all new identities, so this step isn't necessary most of the time.
  • replacement in src/identities.md at line 27
    [3.1506][2.1283:1321]()
    Example (after identity generation) :
    [3.1506]
    [3.1539]
    Example (by default, this is already done for you):