git.iko.soy/urbit.org
on 4e5c9fe help sign in
urbit.org/docs/using/setup.md
99 lines 2.8 kB history raw
1---
2navhome: /docs
3next: true
4sort: 2
5title: Setup
6---
8# Getting started
10On disk your urbit is an append-only log and a checkpoint. Or, in simpler terms, a directory where we keep your urbit’s state. We call this a ‘pier’.
12## Initialize
14To create an urbit, we need an identity. This identity
15is both a network address and a memorable name.
17You are probably creating one of two kinds of urbit: a 32-bit
18"planet" or a 128-bit "comet." For a quick terminology guide
19and high-level refresher, refer to this [handy reference
20sheet](/docs/about/glossary).
22If you have an Urbit invitation, you'll have a planet like
23`~fintud-macrep` and `~fortyv-tombyt-tabsen-sonres`. To create
24your pier:
26 $ bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
28This will create a directory `fintud-macrep/` and begin building
29your urbit. This may take a few minutes.
31If you do not have a ticket, you can still make a 'comet', a wild
32urbit drifting through cyberspace. Pick your own directory name,
33it doesn't matter:
35 $ bin/urbit -c mycomet
37This will create the directory `mycomet/` and generate a 128-bit identity for your urbit.
39## Orientation
41When your urbit is finished booting you should see a `dojo>` prompt. Welcome!
43By default your urbit is quite bare-bones. Let's stroll through what's already running:
45### Shell — `:dojo`
47The command prompt in front of you is a simple shell and Hoon REPL. Let's make sure it works:
49 ~fitund-macrep:dojo> (add 2 2)
51Should produce:
53 > (add 2 2)
54 4
56Good.
58### Messaging — `:talk`
60Use `^X` (ctrl-x) to change your prompt. Let's join the main Urbit chat channel:
62 ~fitund-macrep:talk() ;join ~doznec/urbit-meta
64`:talk` is stateful, so your urbit will download a backlog.
65`/urbit-meta` is the place to ask questions, get help and talk
66about anything Urbit-related.
68### Web — `:tree`
70Urbit is also accessible through the web. Try opening:
72 http://localhost:8080/
74in your favorite browser. You'll be prompted to use `+code`.
75This page was generated by `:tree`, the basic Urbit web
76interface. You can also access your urbit through
77`http://fintud-macrep.urbit.org` (where `fintud-macrep` is your
78planet name).
80### Filesystem — `%clay`
82`%clay`, the Urbit filesystem, isn't mounted to unix by default. Switch to the `:dojo` prompt and run:
84 ~fitund-macrep:dojo> |mount %
86This should produce:
88 > |mount %
89 >=
91which indicates the command was processed.
93`|mount %` will cause a `home/` directory to appear inside your pier folder. Changes to these files are automatically synced into your urbit.
95## Learn more
97If you're eager to get started programming you're ready to head over to <a href="../../hoon/demo">the Hoon demo</a>.
99To learn more about using the system, let's keep going: