git.iko.soy/urbit.org
on f885be7 help sign in
urbit.org/docs/using/setup.md
113 lines 2.9 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
11simpler terms, a directory where we keep your urbit’s state. We call
12this a ‘pier’.
14## Initialize
16To create an urbit, we need an identity. This identity is both a network
17address and a memorable name.
19You are probably creating one of two kinds of urbit: a 32-bit "planet"
20or a 128-bit "comet." For a quick terminology guide and high-level
21refresher, refer to this [handy reference sheet](/docs/about/glossary).
23If you have an Urbit invitation, you'll have a planet like
24`~fintud-macrep` and `~fortyv-tombyt-tabsen-sonres`. To create your
25pier:
27 $ bin/urbit -w fintud-macrep -t fortyv-tombyt-tabsen-sonres
29This will create a directory `fintud-macrep/` and begin building your
30urbit. This may take a few minutes.
32If you do not have a ticket, you can still make a 'comet', a wild urbit
33drifting through cyberspace. Pick your own directory name, it doesn't
34matter:
36 $ bin/urbit -c mycomet
38This will create the directory `mycomet/` and generate a 128-bit
39identity for your urbit.
41## Orientation
43When your urbit is finished booting you should see a `dojo>` prompt.
44Welcome!
46By default your urbit is quite bare-bones. Let's stroll through what's
47already running:
49### Shell — `:dojo`
51The command prompt in front of you is a simple shell and Hoon REPL.
52Let's make sure it works:
54 ~fitund-macrep:dojo> (add 2 2)
56Should produce:
58 > (add 2 2)
59 4
61Good.
63### Messaging — `:talk`
65Use `ctrl-x` to change your prompt. Let's join the main Urbit chat
66channel.
68For planets:
70 ~fitund-macrep:talk() ;join /urbit-meta
72For comets:
74 ~ticlen-nidrup-larwyl-rivtyc--folsel-tocwyl-hosrex-nimder:talk() ;join ~binzod/urbit-meta
76`:talk` is stateful, so your urbit will download a backlog.
77`/urbit-meta` is the place to ask questions, get help and talk about
78anything Urbit-related.
80### Web — `:tree`
82Urbit is also accessible through the web. Try opening:
84 http://localhost:8080/
86in your favorite browser. You'll be prompted to use `+code`. This page
87was generated by `:tree`, the basic Urbit web interface. You can also
88access your urbit through `http://fintud-macrep.urbit.org` (where
89`fintud-macrep` is your planet name).
91### Filesystem — `%clay`
93`%clay`, the Urbit filesystem, isn't mounted to unix by default. Switch
94to the `:dojo` prompt and run:
96 ~fitund-macrep:dojo> |mount %
98This should produce:
100 > |mount %
101 >=
103which indicates the command was processed.
105`|mount %` will cause a `home/` directory to appear inside your pier
106folder. Changes to these files are automatically synced into your urbit.
108## Learn more
110If you're eager to get started programming you're ready to head over to
111<a href="../../hoon/demo">the Hoon demo</a>.
113To learn more about using the system, let's keep going: