git.iko.soy/urbit.org
on 8e3ac7a help sign in
urbit.org/docs/using/setup.md
116 lines 3.0 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 $ 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 $ urbit -c mycomet
38This will create the directory `mycomet/` and generate a 128-bit
39identity for your urbit.
41WARNING: right now (June 2017) the network is extremely slow.
42It will take hours, not minutes, to boot your ship. Sorry!
44## Orientation
46When your urbit is finished booting you should see a `dojo>` prompt.
47Welcome!
49By default your urbit is quite bare-bones. Let's stroll through what's
50already running:
52### Shell — `:dojo`
54The command prompt in front of you is a simple shell and Hoon REPL.
55Let's make sure it works:
57 ~fitund-macrep:dojo> (add 2 2)
59Should produce:
61 > (add 2 2)
62 4
64Good.
66### Messaging — `:talk`
68Use `ctrl-x` to change your prompt. Let's join the main Urbit chat
69channel.
71For planets:
73 ~fitund-macrep:talk() ;join /urbit-meta
75For comets:
77 ~ticlen-nidrup-larwyl-rivtyc--folsel-tocwyl-hosrex-nimder:talk() ;join ~binzod/urbit-meta
79`:talk` is stateful, so your urbit will download a backlog.
80`/urbit-meta` is the place to ask questions, get help and talk about
81anything Urbit-related.
83### Web — `:tree`
85Urbit is also accessible through the web. Try opening:
87 http://localhost:8080/
89in your favorite browser. You'll be prompted to use `+code`. This page
90was generated by `:tree`, the basic Urbit web interface. You can also
91access your urbit through `http://fintud-macrep.urbit.org` (where
92`fintud-macrep` is your planet name).
94### Filesystem — `%clay`
96`%clay`, the Urbit filesystem, isn't mounted to unix by default. Switch
97to the `:dojo` prompt and run:
99 ~fitund-macrep:dojo> |mount %
101This should produce:
103 > |mount %
104 >=
106which indicates the command was processed.
108`|mount %` will cause a `home/` directory to appear inside your pier
109folder. Changes to these files are automatically synced into your urbit.
111## Learn more
113If you're eager to get started programming you're ready to head over to
114<a href="../../hoon/demo">the Hoon demo</a>.
116To learn more about using the system, let's keep going: