content/getting-started/cli.md · urbit.org

git.iko.soy/urbit.org

on c14aa92 help sign in

urbit.org/content/getting-started/cli.md

200 lines 7.4 kB history raw

1+++

2title = "Command line install"

3weight = 4

4description = "Installation instructions for power users."

5+++

7If you're a power user, you can run the Urbit virtual machine directly using the command line. Choose the code for your operating system and run the commands in your terminal.

9<div id="os" class="os">

10 <input type="radio" id="macos" name="os" checked>

11 <label for="macos">MacOS</label>

12 <div class="tab">

14```bash

15mkdir ~/urbit

16cd ~/urbit

17curl -JLO https://urbit.org/install/mac/latest

18tar zxvf ./darwin.tgz --strip=1

19~/urbit/urbit

20```

22 </div>

24 <input type="radio" id="linux" name="os">

25 <label for="linux">Linux</label>

26 <div class="tab">

28```shell

29mkdir ~/urbit

30cd ~/urbit

31wget --content-disposition https://urbit.org/install/linux64/latest

32tar zxvf ./linux64.tgz --strip=1

33~/urbit/urbit

34```

36Linux users may need to run this command in another terminal window to access your Urbit on port 80:

38```shell

39sudo apt-get install libcap2-bin

40sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit

41```

43</div>

45 <input type="radio" id="windows" name="os">

46 <label for="windows">Windows</label>

47 <div class="tab">

49```winbatch

50mkdir %USERPROFILE%\urbit

51cd %USERPROFILE%\urbit

52curl -JLO https://urbit.org/install/windows/latest

53tar zxvf .\windows.tgz --strip=1

54%USERPROFILE%\urbit\urbit

55```

57> Windows 10 build 17063 and later includes the familiar `curl` and `tar` command-line tools.

59</div>

60</div>

62If successful, you will see a block of output beginning with the line:

64```

65Urbit: a personal server operating function

66```

68### Booting a free identity {#comet}

70There are two parts to Urbit: an **ID** and an **Operating System**.

72You have just installed the Operating System on your computer.

74The **ID** is similar to a username and password on another site. The difference is that the public part (the username) is verified by thousands of people around the world while only you hold the key (the password) to that ID.

76There are five kinds of Urbit IDs but to get started you only need to know about two: we call them **planets** and **comets**.

78---

80**Planets** are scarce (this prevents spamming, among other things) and usually require a price to acquire. This is the recommended way to run Urbit, but it's a bit more involved.

82A planet name looks like `~sampel-palnet`.

84[Follow this guide](/getting-started/planet) if you have already acquired a planet.

86[Find a planet to purchase](/getting-started#get-a-planet)

88---

90**Comets** are practically unlimited and free to acquire. At present, these are a great way to try out the network for free.

92A comet name looks like `~dasres-ragnep-lislyt-ribpyl--mosnyx-bisdem-nidful-marzod`.

94[Read more about Urbit ID here](/understanding-urbit/urbit-id)

96---

98To boot a comet, go into the command line and run the following command from the `urbit` directory you created during [Urbit installation](#os).

100```sh

101~/urbit/urbit -c mycomet

102```

103

104It may take a while to load the comet (probably only take a few minutes, but it could take longer). This comes along with it being free. When it's done you'll some messages ending like this:

105

106```

107ames: live on 31337

108http: web interface live on http://localhost:8080

109http: loopback live on http://localhost:12321

110~sampel_marzod:dojo>

111```

112

113When your comet is finished booting, you will see `~sampel_marzod:dojo>` (Dojo: the Urbit command line).

114

115To exit Urbit, use `Ctrl-D` or enter `|exit` into Dojo.

116

117To start your comet up again, run the following from your `urbit` directory (note the lack of `-c` argument):

118

119```sh

120~/urbit/urbit mycomet

121```

122

123### Using the web interface

124

125Urbit is an entirely new computer, so by default it drops you into the "dojo," which is its terminal. Like your current computer, it can be used to do just about anything if you know the right commands. You only need to know one command for now.

126

127At the moment, the most common way to use Urbit is by launching apps like Groups (a communications suite) from the web interface homescreen. The web interface allows you to use your ship without touching the terminal. You just need to get the password, or `code`, from the terminal.

128

1291. With your Urbit running, look for a line that says something like `http: web interface live on http://localhost:8080`. The number given is the port that your ship is using. It will most likely be 80 or 8080, but we're just making sure.

1302. If the port given is `80`, simply type `localhost` into your browser's address bar. If the given port is a different number, such as `8080`, you would type `localhost:8080`. You'll be met with a login prompt.

1313. In the window where you found the port number, type `+code` and press return. Copy-paste the code that appears into the "Access Key" field in the browser, and press continue.

1324. Once in, take a look around and try launching an app like Groups.

133

134## Next Steps

135

136### Updating your comet {#updating}

137

138Urbit comes with a recent release of the Urbit OS, but automatic updates of the `%base` desk (which contains the kernel of the OS) are not enabled by default for Comets. Many comets are used only once and thrown away, so it would be wasteful to update every single comet as soon as it boots. If you plan to use your comet for more than a quick test, you'll probably want to ensure you're running the latest version of the OS.

139

140You can enable updates for your comet by typing `|install (sein:title our now our) %kids, =local %base` into Dojo and pressing Enter.

141

142```

143> |install (sein:title our now our) %kids, =local %base

144>=

145kiln: activated install into %base from [~samzod %kids]

146kiln: downloading update for %base from [~samzod %kids]

147```

148

149### Read More about the Dojo {#the-dojo}

150

151The dojo is Urbit's command line. You can use it to control your ship, or to execute arbitrary code. Check out the links below for more information.

152

153- [Basic Operations](/using/os/getting-started)

154- [Basic Hoon](/docs/tutorials/hoon/hoon-school/setup)

155- [Glossary Entry](/docs/glossary/dojo)

156

157### Purchase a Permanent Identity {#boot-your-planet}

158

159You can continue using this comet indefinitely. There are currently few differences between using a comet-level identity and a planet-level one. However, some groups will not allow comets entry in order to maintain a certain level of quality, and changes may be made in the future that further devalue comets. They will always, however, be able to access the basic functions of the network.

160

161A comet also comes with a long and fairly unmemorable name whereas a planet has a short name and a "sigil" (avatar) associated with it that makes it more identifiable on the network. You may notice all this within the first few minutes of using Urbit.

162

163[For details of how to purchase a planet, visit this page](/getting-started#get-a-planet).

164

165<style>

166 .os {

167 display: flex;

168 flex-wrap: wrap;

169 }

170 .os label {

171 order: -1;

172 padding: .5rem;

173 min-width: 70px;