git.iko.soy/urbit.org
on cd863bb help sign in
urbit.org/content/getting-started/cli.md
160 lines 6.5 kB history raw
1+++
2title = "Command line install"
3weight = 4
4description = "Installation instructions for power users."
5tag = "additional"
6+++
8If 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.
10{% tabs %}
12{% tab label="MacOS" %}
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{% /tab %}
24{% tab label="Linux" %}
26```shell
27mkdir ~/urbit
28cd ~/urbit
29wget --content-disposition https://urbit.org/install/linux64/latest
30tar zxvf ./linux64.tgz --strip=1
31~/urbit/urbit
32```
34Linux users may need to run this command in another terminal window to access your Urbit on port 80:
36```shell
37sudo apt-get install libcap2-bin
38sudo setcap 'cap_net_bind_service=+ep' ~/urbit/urbit
39```
41{% /tab %}
43{% tab label="Windows" %}
45```winbatch
46mkdir %USERPROFILE%\urbit
47cd %USERPROFILE%\urbit
48curl -JLO https://urbit.org/install/windows/latest
49tar zxvf .\windows.tgz --strip=1
50%USERPROFILE%\urbit\urbit
51```
53> Windows 10 build 17063 and later includes the familiar `curl` and `tar` command-line tools.
55{% /tab %}
57{% /tabs %}
59If successful, you will see a block of output beginning with the line:
61```
62Urbit: a personal server operating function
63```
65### Booting a free identity {% #comet %}
67There are two parts to Urbit: an **ID** and an **Operating System**.
69You have just installed the Operating System on your computer.
71The **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.
73There are five kinds of Urbit IDs but to get started you only need to know about two: we call them **planets** and **comets**.
75---
77**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.
79A planet name looks like `~sampel-palnet`.
81[Follow this guide](/getting-started/) if you have already acquired a planet.
83[Find a planet to purchase](/getting-started/get-planet)
85---
87**Comets** are practically unlimited and free to acquire. At present, these are a great way to try out the network for free.
89A comet name looks like `~dasres-ragnep-lislyt-ribpyl--mosnyx-bisdem-nidful-marzod`.
91[Read more about Urbit ID here](/understanding-urbit/urbit-id)
93---
95To boot a comet, go into the command line and run the following command from the `urbit` directory you created during [Urbit installation](#os).
97```sh
98~/urbit/urbit -c mycomet
99```
101It 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:
103```
104ames: live on 31337
105http: web interface live on http://localhost:8080
106http: loopback live on http://localhost:12321
107~sampel_marzod:dojo>
108```
110When your comet is finished booting, you will see `~sampel_marzod:dojo>` (Dojo: the Urbit command line).
112To exit Urbit, use `Ctrl-D` or enter `|exit` into Dojo.
114To start your comet up again, run the following from your `urbit` directory (note the lack of `-c` argument):
116```sh
117~/urbit/urbit mycomet
118```
120### Using the web interface
122Urbit 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.
124At 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.
1261. 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.
1272. 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.
1283. 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.
1294. Once in, take a look around and try launching an app like Groups.
131## Next Steps
133### Updating your comet {% #updating %}
135Urbit 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.
137You can enable updates for your comet by typing `|install (sein:title our now our) %kids, =local %base` into Dojo and pressing Enter.
139```
140> |install (sein:title our now our) %kids, =local %base
141>=
142kiln: activated install into %base from [~samzod %kids]
143kiln: downloading update for %base from [~samzod %kids]
144```
146### Read More about the Dojo {% #the-dojo %}
148The 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.
150- [Basic Operations](/using/os/getting-started)
151- [Basic Hoon](/docs/tutorials/hoon/hoon-school/setup)
152- [Glossary Entry](/docs/glossary/dojo)
154### Purchase a Permanent Identity {% #boot-your-planet %}
156You 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.
158A 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.
160[For details of how to purchase a planet, visit this page](/getting-started/get-planet).