Files
heartwood/radicle-cli/examples/rad-checkout.md
T
Alexis Sellier 0a93fa833e cli: Simplify & improve CLI output
Improvements to the CLI output as well as converging towards
`termion` as a backend.

The crates we were using for prompting and spinners were based on
a terminal backend called `console`, which is not really used
anywhere else. There were also limitations in terms of the output
of these crates.

Therefore, we switched to the `inquire` crate for prompting, using
the `termion` backend, which is very standard.

Additionally, we simplify the terminal output to use symbols:

! for Warning
✓ for Success
✗ for Error

... Instead of a mix of words and symbols.

We also include a modified version of the `yansi` crate which plays
well with our table formatting functions by automatically truncating
and padding output in a unicode-aware way.
2023-02-27 17:10:52 +01:00

1.1 KiB

With the rad checkout command, you can create a new working copy from an existing project.

$ rad checkout rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji

Initializing local checkout for 🌱 rad:z42hL2jL4XNk6K8oHQaSWfMgCL7ji (heartwood)

✓ Performing checkout...

🌱 Project checkout successful under ./heartwood

Let's have a look at what the command did. Navigate to the working copy:

$ cd heartwood

Check the README:

$ cat README
Hello World!

Check the repository status:

$ git status
On branch master
Your branch is up to date with 'rad/master'.

nothing to commit, working tree clean

Check the remote configuration:

$ git remote --verbose
rad	rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi (fetch)
rad	rad://z42hL2jL4XNk6K8oHQaSWfMgCL7ji/z6MknSLrJoTcukLrE435hVNQT4JUhbvWLX4kUzqkEStBU8Vi (push)

List the branches:

$ git branch --all
* master
  remotes/rad/master

List the references:

$ git show-ref
f2de534b5e81d7c6e2dcaf58c3dd91573c0a0354 refs/heads/master
f2de534b5e81d7c6e2dcaf58c3dd91573c0a0354 refs/remotes/rad/master