radicle-heartwood-lfs/radicle-cli/examples/rad-inspect.md

76 lines
1.7 KiB
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

To display a repository's identifier, or *RID*, you may use the `rad inspect`
command from inside a working copy:
```
$ rad inspect
rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji
```
As a shorthand, you can also simply use `rad .`:
```
$ rad .
rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji
```
It's also possible to display all of the repository's git references:
```
$ rad inspect --refs
z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
└── refs
   ├── cobs
   │   └── xyz.radicle.id
   │      └── 2317f74de0494c489a233ca6f29f2b8bff6d4f15
   ├── heads
   │   └── master
   └── rad
      ├── id
      └── sigrefs
```
Or display the repository identity's payload and delegates:
```
$ rad inspect --payload
{
"xyz.radicle.project": {
"defaultBranch": "master",
"description": "Radicle Heartwood Protocol & Stack",
"name": "heartwood"
}
}
$ rad inspect --delegates
did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi
```
Finally, the `--history` flag allows you to examine the identity document's
history:
```
$ rad inspect --history
commit 2317f74de0494c489a233ca6f29f2b8bff6d4f15
blob d96f425412c9f8ad5d9a9a05c9831d0728e2338d
date Thu, 15 Dec 2022 17:28:04 +0000
Initialize identity
{
"payload": {
"xyz.radicle.project": {
"defaultBranch": "master",
"description": "Radicle Heartwood Protocol & Stack",
"name": "heartwood"
}
},
"delegates": [
"did:key:z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi"
],
"threshold": 1
}
```
The identity document is the metadata associated with a repository, that is
only changeable by delegates.