/ radicle-cli / examples / rad-inspect.md
rad-inspect.md
 1  To display a repository's identifier, or *RID*, you may use the `rad inspect`
 2  command from inside a working copy:
 3  
 4  ```
 5  $ rad inspect
 6  rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji
 7  ```
 8  
 9  As a shorthand, you can also simply use `rad .`:
10  
11  ```
12  $ rad .
13  rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji
14  ```
15  
16  It's also possible to display all of the repository's git references:
17  
18  ```
19  $ rad inspect --refs
20  z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
21  └── refs
22      ├── cobs
23      │   └── xyz.radicle.id
24      │       └── 2317f74de0494c489a233ca6f29f2b8bff6d4f15
25      ├── heads
26      │   └── master
27      └── rad
28          ├── id
29          └── sigrefs
30  ```
31  
32  Or display the repository identity's payload and delegates:
33  
34  ```
35  $ rad inspect --payload
36  {
37    "xyz.radicle.project": {
38      "defaultBranch": "master",
39      "description": "Radicle Heartwood Protocol & Stack",
40      "name": "heartwood"
41    }
42  }
43  $ rad inspect --delegates
44  did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
45  ```
46  
47  Finally, the `--history` flag allows you to examine the identity document's
48  history:
49  
50  ```
51  $ rad inspect --history
52  commit 2317f74de0494c489a233ca6f29f2b8bff6d4f15
53  blob   d96f425412c9f8ad5d9a9a05c9831d0728e2338d
54  date   Thu, 15 Dec 2022 17:28:04 +0000
55  
56      Initialize identity
57  
58   {
59     "payload": {
60       "xyz.radicle.project": {
61         "defaultBranch": "master",
62         "description": "Radicle Heartwood Protocol & Stack",
63         "name": "heartwood"
64       }
65     },
66     "delegates": [
67       "did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi"
68     ],
69     "threshold": 1
70   }
71  
72  ```
73  
74  The identity document is the metadata associated with a repository, that is
75  only changeable by delegates.