---
# System prepended metadata

title: Radicle Guide

---

<!-- 

Part 1 (Everyone)

* Intro
* Have user setup identity
    * rad self
    * Local storage
    * $RAD_HOME
    * Use of cryptography instead of logins
    * ssh-agent integration
* Have node running
    * Connect to seeds
    * Set alias
    * Check status
    * P2p vs. servers
* Getting a repo on radicle
    * Replication
* Init repo

Part 2 (contributor)

* Clone a repo
* Track peers
* Sync/fetch
* Patch open
* Patch update

Part 3 (maintainer)

* Managing patches (listing, showing)
* Merge patch
* Tracking

Part 4 (seed node operator)

* Setting up a radicle seed node
* Tracking
* Listening
* Logs
* Ports/firewall config
* Systemd

Part 5 (move to other device)

* How to preserve the identity

Part 6 (anyone)

* Optionally have httpd running
    * app.radicle.xyz

-->

## Getting started

Authentication (to initialize the identity)

    $ rad auth

<!-- TODO: Ask for node alias and configure it somewhere -->

Self

    $ rad self
    
### Getting the node running

Checking node status

    $ rad node status

Starting the node

    $ rad node start [--daemon]
    
Connecting to the network

    $ rad node connect <nid> <addr>

Give example of seed.radicle.xyz.
    
<!-- TODO: Setup seed.radicle.community  | *.radicle.garden -->
<!-- TODO: If neither --listen or --connect are specified, throw a warning  -->

Check that node is running

    $ rad node status

<!-- TODO: Have way to check node connections -->

### Getting a repo on radicle

Starting from an existing repo:

    $ cd my-repo
    $ rad init

<!-- TODO: Make sure user understands that repo will be visible on the network -->

Check current project

    $ rad .
    $ rad inspect --payload

Check your local repos

    $ rad ls

The `rad` remote:

    $ git remote show rad 
    
Push changes

    $ git push rad

Synchronizing changes

    $ rad sync
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    
    