@@ -1,1421 +0,0 @@
1−+++
2−title = "Using Your Ship"
3−description = "How to operate your ship, including using your ship's filesystem and messaging applications, starting a moon, or requesting a DNS proxy."
4−template = "page_indiced.html"
5−weight = 2
6−[extra]
7−hidetitle = "true"
8−+++
9−
10−## Using your ship
11−
12−Your urbit (also called your _ship_) is a persistent Unix process that you mainly control from the console.
13−
14−### Shutdown
15−
16−You can turn your urbit off with `Ctrl-d` from the Chat or Dojo prompts.
17−
18−You can force-quit your urbit with `Ctrl-z` from anywhere.
19−
20−### Restart
21−
22−To restart your urbit simply pass the name of your pier:
23−
24−```sh
25−$ ./urbit some-planet
26−```
27−
28−or
29−
30−```sh
31−$ ./urbit comet
32−```
33−
34−### Logging
35−
36−To log an urbit's command line output to a file, use `script`:
37−
38−```sh
39−$ script urbit.log ./urbit your-urbit
40−```
41−
42−### Moving your pier
43−
44−Piers are designed to be portable, but it _must_ be done while the urbit
45−is not running. Urbit networking is stateful, so you can't run two copies
46−of the same urbit in two places.
47−
48−To move a pier, simply move the contents of the directory it lives in.
49−To keep these files as small as possible we usually use the `--sparse`
50−option in `tar`. With a pier `your-urbit/`, something like this should work:
51−
52−```sh
53−tar -Scvzf ~/your-urbit.tar.gz ~/your-urbit/
54−scp your-old-server:~/your-urbit.tar.gz your-new-server:~
55−```
56−
57−Then to unzip it, on your other Unix server, run:
58−
59−```sh
60−tar xfvz your-urbit.tar.gz
61−```
62−
63−Delete the tar file, and, after installing Urbit on your new server, start your urbit back up with:
64−
65−```sh
66−./urbit your-urbit
67−```
68−
69−### Hardware requirements
70−
71−Urbit can run on any x86 computer (unofficial, unsupported [ARM binaries](https://botter-nidnul.github.io/AArch64_Urbit_Static_Binaries.html) are also available), ideally with at least 2GB of RAM.
72−
73−Urbit maintains a persistent log of the history of your ship. Eventually this log will be automatically trimmed when necessary, but for now it only increases in size. An actively used planet will consume 5-50 GB of storage space per year of operation.
74−
75−### Console
76−
77−Your Urbit terminal is separated into two parts: the prompt (the bottom line) and the record (everything above that). The record is shared; all the output from all the apps in your command set appears in it. The prompt is multiplexed.
78−
79−In the CLI, Urbit apps can process your input before you hit return. To see this in action try entering `)` as the first character at the Dojo prompt. Since there is no Dojo command or Hoon expression that starts with ')', the Dojo rejects it.
80−
81−`Ctrl-x` - Switches the prompt between running console apps
82−
83−`Ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack
84−trace.
85−
86−`Ctrl-d` - From Chat or Dojo, stops your Urbit process.
87−
88−`Ctrl-z` - Stops the Urbit process from _anywhere_.
89−
90−`↑` / `↓` - History navigation
91−
92−The following emacs-style key bindings are available:
93−
94−```
95−Ctrl-a Cursor to beginning of the line (Home)
96−Ctrl-b Cursor one character backward (left-arrow)
97−Ctrl-e Cursor to the end of the line (End)
98−Ctrl-f Cursor one character forward (right-arrow)
99−Ctrl-g Beep; cancel reverse-search
100−Ctrl-k Kill to end of line
101−Ctrl-l Clear the screen
102−Ctrl-n Next line in history (down-arrow)
103−Ctrl-p Previous line in history (up-arrow)
104−Ctrl-r Reverse-search
105−Ctrl-t Transpose characters
106−Ctrl-u Kill to beginning of line
107−Ctrl-y Yank from kill buffer
108−```
109−
110−### Updates
111−
112−By default, you will automatically receive updates ([OTAs](@/docs/glossary/ota-updates.md)) from your sponsor. To check your OTA source, run `|ota` in the [dojo](@/docs/glossary/dojo.md).
113−
114−If for some reason (for example, if your sponsor is out of date), you can switch OTA sources by running `|ota ~otasrc %kids` in the dojo, where `~otasrc` is the ship from which you want to receive updates. It is a good idea to contact the source ship and ask permission to sync from them.
115−
116−If OTAs are not succeeding, or if you are on an version of Urbit before the `|ota` command was introduced, you can run `|merge %home (sein:title our now our) %kids, =gem %take-that`. **Note:** This will wipe out any custom changes to the base distribution.
117−
118−#### Additional OTA Troubleshooting
119−Please check the Support Wiki for additional OTA troubleshooting, such as:
120−[OTA 1.0.71 failed](https://github.com/urbit/support/wiki/OTA-1.0.71-failed),
121−[Missing OTA](https://github.com/urbit/support/wiki/Missing-OTA),
122−[Stuck flow preventing planets from receiving
123−OTAs](https://github.com/urbit/support/wiki/Stuck-flow-preventing-planets-from-receiving-OTAs),
124−and [No content shows in Links page after OTA](https://github.com/urbit/support/wiki/No-content-shows-in-Links-page-after-OTA).
125−
126−### Landscape
127−
128−On startup Urbit tries to bind to `localhost:80`. If you're already running something on port `80` -- such as any other HTTP server, or another urbit -- you'll find the urbit that you just started on `8080`, `8081`, and so on. For planets only, we also proxy web domains through Urbit's own servers. Any planet `~your-urbit` is also at `your-urbit.arvo.network`, but only after you [set up DNS](#dns-proxying).
129−
130−Once running, you can sign into Landscape, your ship’s web interface, from `http://localhost` or `https://your-urbit.arvo.network`. Since our HTTPS isn't audited / battle tested, we just call it "secure" HTTPS. You can find that on `8443`. Or `8444` (and so on) if you're already running something on `8443`.
131−
132−### Moons {#moons}
133−
134−Planets can spawn moons, which are meant for connected devices: phones, smart TVs, digital thermostats. The basic idea is that your planet runs permanently in a data center somewhere, while moons run on all your devices. Each planet can issue ~4 billion (`2^32`) moons.
135−
136−To generate a random moon from your planet, run:
137−
138−```
139−~sampel-palnet:dojo> |moon
140−moon: ~faswep-navred-sampel-palnet
141−\/0w5cT5t.wCO6i.~e1xg.Oz0qb.QNO6I.3Kt2T.h9M9F.U3vU~.X3Qu0.gtb19.IYTkY.80kWZ.SI\/
142− EUE.DXa8i.TiDof.o3-1C.RHLKS.k81M0.ecz5o.ic0Bg.600g1
143−\/ \/
144−```
145−
146−You must manually edit the output of `|moon` to get the correct format for the `<key>`:
147−
148−- strip out the `\/`
149−
150−- combine into one line, omitting spaces
151−
152−`<key>` would be `0w5cT5t.wCO6i.~e1xg.Oz0qb.QNO6I.3Kt2T.h9M9F.U3vU~.X3Qu0.gtb19.IYTkY.80kWZ.SIEUE.DXa8i.TiDof.o3-1C.RHLKS.k81M0.ecz5o.ic0Bg.600g1`
153−in this example.
154−
155−Put `<key>` in a file and that file becomes `<keyfile>`.
156−
157−You can use the resulting output in the same installation flow from the [Installing Urbit](@/using/running/install.md) guide, following the same scheme as for booting a planet. That scheme is:
158−
159−```sh
160−$ ./urbit -w <moonname> -G <key> -c <piername>
161−```
162−
163−or
164−
165−```sh
166−$ ./urbit -w <moonname> -k <keyfile> -c <piername>
167−```
168−
169−The `-c <piername>` argument is not required, but it is recommended; otherwise,
170−the resulting directory is a rather unwieldy moon name.
171−
172−Here's how an example moon might be booted:
173−
174−```sh
175−$ ./urbit -w faswep-navred-sampel-palnet -G <key> -c mymoon
176−```
177−
178−or
179−
180−```sh
181−$ ./urbit -w faswep-navred-sampel-palnet -k <keyfile> -c mymoon
182−```
183−
184−Moons are automatically synced to their parent `%kids` desk, and can control applications on their parent planet using `|link`.
185−
186−To breach a moon -- that is, to reset its presence on the network so that it's treated as a freshly spawned ship by others -- run from the parent ship:
187−
188−```
189−|moon-breach ~faswep-navred-sampel-palnet
190−```
191−
192−To cycle the keys of a moon without breaching, run:
193−
194−```
195−|moon-cycle-keys ~sampel-sipnym-wicdev-wisryt
196−```
197−
198−
199−### Escaping A Sponsor {#escape}
200−
201−To use the network as a planet or star, you must be sponsored by an active star
202−or galaxy, respectively. If your sponsor isn't suiting your needs, you can
203−escape to a different one. This can be done with
204−[Bridge](https://bridge.urbit.org/) following the instructions
205−[here](@/using/id/using-bridge.md#escaping-your-sponsor).
206−
207−### Continuity breaches
208−
209−While the Urbit network is in this alpha state, we sometimes have to reboot the whole network. This happens either when major changes need to be shipped or we hit a bug that can't be fixed over the air.
210−
211−Because Urbit networking is stateful we call this a _continuity breach_. Everything has to be restarted from scratch. Your pier will continue to function after we have breached, but it won’t connect to the rest of the Urbit network.
212−
213−When this happens, back up any files you'd like to save, shut down your urbit, and recreate it (as if you were starting for the first time).
214−
215−### Life and rift number
216−
217−You can check your ship's _life_ and _rift_ number by running `+keys our` in
218−dojo. You can inspect another ship's life and rift number by running `+keys
219−~sampel-palnet`. For information on what life and rift are, see [Guide to Breaches](@/docs/tutorials/guide-to-breaches.md).
220−
221−## DNS proxying {#dns-proxying}
222−
223−We have a system that lets you request a domain name for your ship in the form of `ship.arvo.network`, where `ship` is your ship's name minus the `~`. This allows users to access their ships remotely using Landscape, our graphical web interface.
224−
225−Stars and planets follow the same process DNS proxying process, and galaxies have their own requirements. Moons and comets are not supported.
226−
227−### Planets and Stars
228−
229−For a planet or star's DNS proxying request to be made and fulfilled, they must be hosting their ship someplace with a public IP address, and its HTTP server must be listening on port 80.
230−
231−To get `ship.arvo.network` on a planet or star, you must set up DNS routing with its parent ship by starting the `:dns` app.
232−
233−To do so, simply run this command in your ship's Dojo, passing the IP address as an argument, using the .0.0.0.0 (`@if`) syntax. For example:
234−
235−```
236−> -dns-address &dns-address [%if .1.2.3.4]
237−```
238−
239−`:dns`, running locally, will make an HTTP request to that IP address on port 80 to confirm that it is itself available at that IP and port. If that fails, you'll receive a `%bail-early` message in `:chat-cli`; this request will retry a few times. If the self-check is successful, the request is relayed to `~zod`, and you'll receive a message saying, `request for DNS sent to ~zod`. Once `~zod` has acknowledged receipt of the request, your local `:dns` app will send a `:chat-cli` message saying `awaiting response from ~zod`.
240−
241−The request will be picked up shortly, and the `ship.arvo.network` DNS record will be set to the given IP address. Once that's set up, `~zod` will be notified and `~zod` will, in turn, notify your ship. That ship will now try to verify that it can reach itself on `ship.arvo.network` over port 80. If it can't, it'll send a message saying, `unable to access via ship.arvo.network`. If it can, it will configure itself with that domain and say `confirmed access via ship.arvo.network`.
242−
243−Great! You're set up now. Try accessing your `ship.arvo.network` in your browser to use Landscape; we recommend Chrome or Brave.
244−
245−### Configuring SSL
246−
247−To enable SSL on your ship, use the `acme` agent, which will request a certificate through Let's Encrypt. First, make sure the agent is started:
248−
249−```
250−> |start %acme
251−```
252−
253−Next, provide the path for the SSL certificate by poking the `acme` agent. The path format is `/tld/your_domain/your_subdomain`, so if your domain is `sampel-palnet.arvo.network`, you'd use it like so:
254−
255−```
256−> :acme &path /network/arvo/sampel-palnet
257−```
258−
259−### Galaxies
260−
261−Galaxies are already required to have separate DNS entry at galaxy.urbit.org. There's no automated process for getting that binding, so if you're a galaxy-holder, get in touch with us at support@urbit.org.
262−
263−There is a command for galaxies that will try to re-use their already-necessary Ames DNS entry for HTTPS:
264−
265−```
266−> -dns-auto
267−```
268−
269−This will make HTTP-requests to self-check availability over `galaxy.$AMES-DOMAIN` (currently galaxy.urbit.org), where `galaxy` is the galaxy's name minus the `~`.
270−
271−Otherwise, `-dns-auto` works the same as `:dns|ip` does with stars and planets: if it's available or unavailable, Chat messages, and so on.
272−
273−### Ports
274−
275−The built-in logic for listening on port 80 is to try to bind to port 80; if it cannot, it tries 8080, then increments until it can bind a port. Port 80 is available to unprivileged process on recent version of macOS. Otherwise, the process needs to either be run as root, or be given special permission (CAP\_NET_BIND on Linux).
276−
277−## Messaging {#messaging}
278−
279−Let’s get started using the `:chat-cli` application, also known more simply as _Chat_. It's the simplest way to talk to people using the command line interface.
280−
281−### Quickstart
282−
283−The most common use for `:chat-cli` right now is, of course, communicating in group chats.
284−
285−### Joining a chat
286−
287−In `:chat-cli`, any kind of medium for a message is called a _chat_. There are four "types" of chats, but for now we'll be dealing with the _channel_, a publicly accessible chatroom for general use. We'll discuss the other three kinds in the [chat management](#chat-management) section later on.
288−
289−Join the Urbit Community from Dojo using `:group-store|join ~bitbet-bolbel/urbit-community`. Once you've joined, join the General chat from chat-cli. Use `ctrl-x` to switch from the Dojo prompt to the Chat prompt.
290−
291−Then:
292−
293−```
294−~sampel-palnet:chat-cli/ ;join ~darrux-landes/general
295−```
296−
297−Now that you're in, try post a line to `~darrux-landes/general`:
298−
299−```
300−~sampel-palnet:chat-cli= Hello, world!
301−```
302−
303−You'll see your message printed below messages from others that came before it. You can always type `;chats` in the `chat-cli` prompt to list all the chats you're in:
304−
305−```
306−~sampel-palnet:chat-cli= ;chats
307−~darrux-landes/general
308−```
309−
310−Glyphs will be automatically assigned to channels, but have the option of binding a glyph (single non-alphanumeric character) to the channel you're joining; the syntax is in the form of `;join ~/~dopzod/books +`. The chosen glyph will be the symbol that ends your prompt, and it will be what you use as a shortcut to switch to this channel.
311−
312−```
313−~sampel-palnet:chat-cli= ;+
314−~sampel-palnet:chat-cli+
315−```
316−
317−Use `;leave` to unsubscribe from a channel:
318−
319−```
320−~sampel-palnet:chat-cli= ;leave ~darrux-landes/general
321−```
322−
323−Now, let's create a channel we can invite some friends to:
324−
325−```
326−~sampel-palnet:chat-cli= ;create channel /my-channel
327−```
328−
329−Now you can tell your friends to `;join ~your-urbit/my-channel`.
330−
331−In order to see messages in `:chat-cli` you may need to do the following in Dojo:
332−
333−```
334−:chat-cli %connect
335−```
336−
337−### Hoon
338−
339−You can use Chat to evaluate Hoon code and share the results with everyone in a chat. To do so, preface your Hoon with `#`.
340−
341−```
342−~sampel-palnet:chat-cli= #(add 2 2)
343−```
344−
345−This will print as:
346−
347−```
348−~sampel-palnet# (add 2 2)
349− 4
350−```
351−
352−### URLs
353−
354−To share a URL, send it as its own message, with no content before or after it.
355−
356−```
357−~sampel-palnet:chat-cli= https://urbit.org/
358−```
359−
360−This will print as:
361−
362−```
363−~sampel-palnet/ https://urbit.org/
364−```
365−
366−### Expanding messages
367−
368−In the case of URLs, they may be too long to display on a single message line. For Hoon code, the code or result could be big. In `:chat-cli`, these get shortened when initially printed out. To view the entire contents, you can select the message in various ways.
369−
370−```
371−~sampel-palnet+ some message
372−----------[240]
373−~sampel-palnet+ let's try selecting this message!
374−~sampel-palnet+ another message
375−~sampel-palnet:chat-cli=
376−```
377−
378−In the above example, we can select the middle message by issuing any of the following command:
379−
380−```
381−;240
382−;40
383−;;
384−```
385−
386−`;n` looks for the last message whose sequence number ends in `n`. `;;` simply picks the second-to-last message.
387−
388−Detailed message output will look something like this:
389−
390−```
391−? 240
392− 0v5.g7r7l.n0d7m.mp4bn.gp6vr.sm5lj at ~2019.10.17..22.08.27..8a03
393− ~sampel-palnet
394− to ~dopzod/urbit-help
395−let's try selecting this message!
396−```
397−
398−### Creating and managing chats {#chat-management}
399−
400−As mentioned before, any urbit can host any number of chats. Existing chats can be deleted or modified with various commands. All commands in this section should be sent from the `chat-cli>` prompt.
401−
402−#### Create
403−
404−Syntax: `;create [type] /name +`, where `+` represents an optional glyph.
405−
406−Creates and joins a chat, where `[type]` is any of the following:
407−- `channel`: public chat. Has a blacklist for write control.
408−- `village`: invite-only chat.
409−- `journal`: publicly readable, invite-only for writing.
410−- `mailbox`: publicly writeable, invite-only for reading.
411−
412−Let's create an example mailbox:
413−
414−```
415−~sampel-palnet:chat-cli> ;create mailbox /coolbox ^
416−```
417−
418−#### Delete
419−
420−Syntax: `;delete /name`
421−
422−Deletes a chat.
423−
424−#### Permission management
425−
426−You can permit and ban people from reading and/or writing to the chats you host, using `;invite` and `;banish` command respectively.
427−
428−Syntax: `;invite [rw] /name ~ships`
429−
430−Where `rw` is either `r`, `w`, or `rw`, representing "read" and "write" permissions.
431−And where `~ships` is a comma-seperated list of ships to invite.
432−
433−For example, to grant two people full access to a `village` we created:
434−
435−```
436−~sampel-palnet:chat-cli> ;invite rw /hidden-village ~ravmel-ropdyl, ~rapfyr-diglyt
437−```
438−
439−Similarly, if we later want to revoke the writing permissions for one of them, but still allow them to read new messages, we can run:
440−
441−```
442−~sampel-palnet:chat-cli> ;banish w /hidden-village ~rapfyr-diglyt
443−```
444−
445−#### Chat glyphs
446−
447−Glyphs are found at the end of your prompt, as a quick indicator of where
448−your messages will be sent.
449−
450−Glyphs are assigned by chat hash out of the following list:
451−
452−```
453−! @ # $ % ^ & ( ) - = _ + [ ] { } ; ' \ : " , . < > ?
454−```
455−
456−Alphanumeric characters and `|#/*~` are reserved; all others can be manually assigned.
457−
458−For example, `-` the glyph at the end of the prompt below might indicates that
459−messages sent from this prompt will go to some chat with that glyph:
460−
461−```
462−~sampel-palnet:chat-cli-
463−```
464−
465−To see what chat is bound to a glyph, use the `;what` command followed by the
466−glyph in question, or use `;what` without specifying a glyph to see all of your
467−subscriptions which are bound to glyphs. For example, to see `=`:
468−
469−```
470−~sampel-palnet:chat-cli> ;what =
471−~dopzod/urbit-help
472−```
473−
474−To see all of your glyph bindings:
475−
476−```
477−~sampel-palnet:chat-cli> ;what
478−> ~paldev/numismatic-forum
479−. ~middev/ny-martians
480−= ~dopzod/urbit-help
481−```
482−
483−When the messaging target doesn't have a glyph, we see their name at the end of
484−the prompt instead. Here we're talking into `~dannum-mitryl/homework`:
485−
486−```
487−~sampel-palnet:chat-cli[~dannum-mitryl/homework]
488−```
489−
490−#### Bind
491−
492−Syntax: `;bind [glyph] ~host/chat-name`
493−
494−Assigns the chosen glyph to a chat.
495−
496−For example:
497−
498−```
499−~sampel-palnet:chat-cli> ;bind + ~dopzod/urbit-help
500−```
501−
502−#### Unbind
503−
504−Syntax: `;unbind [glyph] ~host/chat-name`
505−
506−Unassigns the chosen glyph from a chat owned by your ship.
507−
508−For example:
509−
510−```
511−~sampel-palnet:chat-cli> ;unbind + ~dopzod/urbit-help
512−```
513−
514−If you don't specify a chat, all bindings for that glyph are removed.
515−
516−#### Prefixes
517−
518−Received posts are prefixed with a glyph to let you know what the
519−audience is. You can activate an individual post to see the full
520−audience.
521−
522−There are a few special-purpose "glyphs":
523−
524−- `|` - Informational messages
525−- `*` - Posts to a target you don't have a glyph binding for
526−
527−
528−### Configuration
529−
530−#### Set audience
531−
532−`;~ship/chat`
533−
534−Set audience to `~ship/chat`.
535−
536−#### Set audience by glyph
537−
538−Syntax: `;[glyph]`
539−
540−Set audience to the chat previously bound to the chosen glyph.
541−
542−#### Set audience to own chat
543−
544−Syntax: `;/chat`
545−
546−Set audience to a chat on your own ship.
547−
548−### Miscellaneous configuration
549−
550−#### Change timezone
551−
552−Syntax: `;set timezone [+/-][hours]`
553−
554−Adjust the display of timestamps to a specific timezone. Relative to UTC.
555−
556−#### Set width
557−
558−Syntax: `;set width [number]`
559−
560−Set the rendering width of `:chat-cli` to a specific number of characters.
561−(Minimum of 30.)
562−
563−#### Show timestamps
564−
565−Syntax: `;set showtime`
566−
567−Show the timestamp for each message. This is set by default.
568−
569−#### Hide timestamps
570−
571−Syntax: `;unset showtime`
572−
573−Stop showing the timestamp for each message.
574−
575−#### Sound notification on
576−
577−Syntax: `;set notify`
578−
579−Emit a terminal bell sound if your six-syllable ship name is mentioned in
580−a message. This is set by default.
581−
582−#### Sound notification off
583−
584−Syntax `;unset notify`
585−
586−Do not notify when your ship name is mentioned.
587−
588−
589−## S3 {#s3}
590−
591−Amazon S3, which stands for Amazon Simple Storage Service, is a technology that was introduced by Amazon Web Services for cloud storage that has since been extended more broadly into a [standard programming interface](https://en.wikipedia.org/wiki/Amazon_S3#S3_API_and_competing_services).
592−
593−Our S3 support lets you store credentials for your S3 object storage buckets on your Urbit ship; once you have done so, you will get additional functionality for uploading your own media within Chat and Groups (for avatars).
594−
595−To enable S3 support on your ship you'll need to first set up a bucket, and then add its credentials to Landscape using *either* Landscape or the Dojo.
596−
597−### Bucket Setup
598−
599−If you’re using AWS, it will have to support signature v2, not v4. We've found DigitalOcean's Spaces to work well also. The bucket has to be publicly readable, allow CORS from `*` origins, allow GET and PUT methods, and allow `*` headers. Your provider should have details on setting access permissions and CORS.
600−
601−### Add your credentials: Landscape
602−
603−Navigate to your `https://<your-ship-url>/~profile/settings`, or click your sigil in the upper-right corner of the window. Fill out the **S3 Credentials** and **S3 Buckets** sections and you're all set!
604−
605−### Add your credentials: Dojo
606−
607−Once you have gotten your bucket setup, poke the `s3-store` on your ship with your details. You can do this in Dojo or in web Dojo.
608−
609−```
610−:s3-store|set-endpoint 'endpoint.mys3provider.com'
611−:: AWS endpoint example: s3-us-west-2.amazonaws.com
612−:: Digital Ocean endpoint example: sfo2.digitaloceanspaces.com
613−:s3-store|set-access-key-id 'MYACCESSKEYID'
614−:s3-store|set-secret-access-key 'MYSECRETACCESSKEY'
615−:s3-store|set-current-bucket 'yourbucketname'
616−```
617−
618−Done! If you need to peek at s3-store’s state, you can always run :s3-store +dbug (inside Dojo, not web Dojo, unfortunately). You’ll see the additional functionality appear in Groups and Chat.
619−
620−## Shell {#using-the-shell}
621−
622−The Dojo is our shell; it processes system commands and returns output. It's a
623−good place to quickly experiment with Urbit. On the surface the Dojo is just a
624−Hoon REPL. On the inside, the Dojo is a system for operating on and transforming
625−data in Urbit.
626−
627−### Quickstart
628−
629−You can use the Dojo to run arbitrary Hoon code, as well as non-Hoon system
630−commands.
631−
632−#### Math
633−
634−Evaluate a Hoon expression (whitespace matters):
635−
636−```
637−~your-urbit:dojo> (add 2 2)
638−~your-urbit:dojo> %+ add 2 2
639−```
640−
641−Tall-form Hoon may require multiple lines:
642−
643−```
644−~your-urbit:dojo> %+ add
645−~your-urbit:dojo< 2
646−~your-urbit:dojo< 2
647−```
648−
649−Hoon uses something called [the subject](@/docs/tutorials/hoon/hoon-school/the-subject-and-its-legs.md).
650−The Dojo has its own subject and that's where Hoon's equivalent of variables,
651−called faces, are stored.
652−
653−Use `=var` to save faces to the Dojo subject.
654−
655−```
656−~your-urbit:dojo> =foo (add 2 2)
657−```
658−
659−Note, however, that `=var` is Dojo syntax, not Hoon syntax. You cannot bind a
660−face in a `.hoon` file in this way.
661−
662−#### System commands
663−
664−Use `=dir` to set the current working directory:
665−
666−```
667−~your-urbit:dojo> =dir %/gen
668−```
669−
670−(`%` represents your current directory. For a complete explanation on urbit
671−paths, see the [filesystem section](#filesystem).)
672−
673−Generators (files in `/gen`) are run with `+`:
674−
675−```
676−~your-urbit:dojo> +hello 'world'
677−```
678−
679−Save output to a file in `%clay` with `*`:
680−
681−```
682−~your-urbit:dojo> *some/file/path/hoon 'hello world'
683−```
684−
685−Run system commands from `:hood`, like `reload`, using `|`:
686−
687−```
688−~your-urbit:dojo> |reload %eyre
689−```
690−
691−### Generators
692−
693−Generators are short Hoon scripts, saved as `.hoon` files in the `/gen`
694−directory. Many Dojo commands exist in the form of generators. The syntax for
695−running a generator is `+genname` for a generator saved as `genname.hoon`.
696−
697−#### `+cat`
698−
699−Accepts a path and displays the file. Similar to Unix `cat`.
700−
701−```
702−~your-urbit:dojo> +cat %/gen/curl/hoon
703−```
704−
705−#### `+code`
706−
707−Generates a code that is used to remotely log into your ship. No
708−arguments.
709−
710−```
711−~your-urbit:dojo> +code
712−```
713−
714−You can change your code to a new randomly generated one by entering `|code
715−%reset`. Please note that this will prevent [Bridge](@/docs/glossary/bridge.md)
716−from being able to derive your code in the future.
717−
718−#### `+curl`
719−
720−Retrieves data from a URL. Accepts a `tape`. Similar to Unix `curl`.
721−
722−```
723−~your-urbit:dojo> +curl "http://nyt.com"
724−```
725−
726−#### `+hello`
727−
728−Just prints the argument. Accepts a `@ta`.
729−
730−```
731−~your-urbit:dojo> +hello 'mars'
732−```
733−
734−#### `+ls`
735−
736−Similar to Unix `ls`. Accepts a path.
737−
738−```
739−~your-urbit:dojo> +ls %/gen
740−~your-urbit:dojo> +ls /~talsur-todres/home/2/gen/program
741−```
742−
743−#### `+solid`
744−
745−Compile the current state of the kernel and output a
746−noun. Usually downloaded to a file in unix. No arguments.
747−
748−```
749−~your-urbit:dojo> .urbit/pill +solid
750−```
751−
752−#### `+test`
753−
754−Testrunner. Can test multiple generators at once, conventionally ones
755−in the `/test` folder. Takes a path.
756−
757−```
758−~your-urbit:dojo> +test /lib
759−```
760−
761−#### `+ticket`
762−
763−Generate a ticket for an urbit ship. Takes an urbit name (`@p`).
764−
765−
766−```
767−~your-urbit:dojo> +ticket ~talsur-todres-your-urbit
768−```
769−
770−#### `+tree`
771−
772−Generate a recursive directory listing. Takes a path.
773−
774−```
775−~your-urbit:dojo> +tree %/sys
776−```
777−
778−### Hood
779−
780−The hood is the system daemon. See `gen/hood` and `app/hood`.
781−
782−`|hi` - Sends a direct message. Sort of like Unix `write`. Accepts
783−an urbit name (`@p`) and a string (`tape`, which is text wrapped with double-quotes).
784−
785−```
786−~your-urbit:dojo> |hi ~binzod "you there?"
787−```
788−
789−`|link` / `|unlink` - Link / unlink a remote app. Accepts an
790−Urbit name and an app name.
791−
792−```
793−~your-urbit:dojo> |link ~talsur-todres %octo
794−```
795−
796−`|mass` - Prints the current memory usage of all the kernel modules.
797−No arguments.
798−
799−```
800−~your-urbit:dojo> |mass
801−```
802−
803−`|reload` - Reloads a kernel module (vane) from source. Accepts any
804−number of vane names.
805−
806−```
807−~your-urbit:dojo> |reload %clay %eyre
808−```
809−
810−`|reset` - Reloads `hoon.hoon` and all modules. No arguments.
811−
812−```
813−~your-urbit:dojo> |reset
814−```
815−
816−`|start` - Starts an app. Accepts an app name.
817−
818−```
819−~your-urbit:dojo> |start %curl
820−```
821−
822−---
823−
824−### Dojo manual
825−
826−#### Sources and sinks
827−
828−A Dojo command is either a **source** or a **sink**. A source is just something
829−that can be printed to your console or the result of some computation. A
830−sink is an **effect**: a change to the filesystem, a network message, a
831−change to your environment, or a typed message to an app.
832−
833−Sources can be chained together, but we can only produce one effect per
834−command.
835−
836−#### Sinks
837−
838−#### `=` - Set variable
839−
840−Set any environment variable:
841−
842−```
843−~your-urbit:dojo> =foo 42
844−~your-urbit:dojo> (add 2 foo)
845−
846−44
847−```
848−
849−Make sure to note that `=var` is Dojo syntax, not Hoon syntax. You cannot bind a
850−variable in a `.hoon` file in this way.
851−
852−#### Special variables
853−
854−There are a few special variables that the Dojo maintains.
855−
856−#### `:` - Send to app
857−
858−`:app` goes to a local `app`, `:~ship/app` goes to the `app` on `~ship`.
859−
860−Send a `helm-hi` message to `hood`:
861−
862−```
863−~your-urbit:dojo> :hood &helm-hi 'hi'
864−```
865−
866−Apps usually expect marked data, so `&` is often used here.
867−
868−#### `*` - Save in `%clay`
869−
870−Save a new `.hoon` file in `gen`:
871−
872−```
873−~your-urbit:dojo> *%/gen/foo/hoon '# hello'
874−```
875−
876−The last component of the path is expected to be the mark (or mime
877−type).
878−
879−#### `.` - Export to Unix
880−
881−Export a noun to Unix with `.`:
882−
883−```
884−~your-urbit:dojo> .foo/bar/baz (add 2 2)
885−```
886−
887−Which creates a file at `pier/.urb/put/foo/bar.baz`.
888−
889−This is very often used with `+solid`:
890−
891−```
892−~your-urbit:dojo> .urbit/pill +solid
893−```
894−
895−Which outputs a new `urbit.pill` to `pier/.urb/put/urbit.pill`
896−
897−### Sources
898−
899−#### `_` - Run a function
900−
901−Use `_` to run a gate (or function):
902−
903−Write an arbitrary function and pass data to it:
904−
905−```
906−~your-urbit:dojo> _|=([a=@] (mul a 3)) 3
907−9
908−```
909−
910−Use a function to get the status code from an http request:
911−
912−```
913−~your-urbit:dojo> _|=([p=@ud q=* r=*] p) +http://google.com
914−301
915−```
916−
917−#### `+` `-` - HTTP requests
918−
919−`+http[s]://example.com` - sends a GET request
920−
921−`+http[s]://example.com &json [%s 'hi']` - sends a POST request with the
922−JSON `"hi"` in the body.
923−
924−`-http[s]://example.com &json [%s 'hi']` - sends a PUT request with the
925−JSON `"hi"` in the body.
926−
927−Note that the first of these is a source while the last two are sinks.
928−
929−#### `+` - Generators
930−
931−Generators are simple Hoon scripts loaded from the filesystem. They live
932−in `gen/`.
933−
934−An example of a generator that is built into your urbit is `+code`. It produces
935−the code needed to log into your ship remotely.
936−
937−```
938−~your-urbit:dojo> +code
939−fintyr-haldet-fassev-solhex
940−```
941−
942−### Variables
943−
944−You can use `=` to set an environment variable in Dojo, but there are
945−a few reserved names that have special uses.
946−
947−#### `dir`
948−
949−Current working `%clay` desk and revision. Read / write.
950−
951−**Examples:**
952−
953−```
954−~your-urbit:dojo> =dir %/gen
955−~your-urbit:dojo> +ls %
956−404/hoon docs/ dojo/hoon lib/ listen/hoon md static/udon talk/ testing/udon tree/main/ unmark/ womb/
957−```
958−
959−#### `lib`
960−
961−Current set of libraries (`/lib`) in your environment. Can be set
962−with `/+`. Read / write.
963−
964−**Examples:**
965−
966−```
967−~your-urbit:dojo> /+ number-to-words
968−```
969−Now we can use arms from lib/number-to-words.hoon
970−```
971−~your-urbit:dojo> (to-words:eng-us:number-to-words 123.456)
972−```
973−
974−#### `sur`
975−
976−Current set of structures (`/sur`) in your environment. Can be set
977−with `/-`. Read / write.
978−
979−**Examples:**
980−
981−```
982−~your-urbit:dojo> /- sole
983−```
984−Now we can use arms in sur/sole.hoon.
985−```
986−~your-urbit:dojo> `sole-effect:sole`[%bel ~]
987−```
988−
989−#### `now`
990−
991−The current (128-bit `@da`) time. Read-only.
992−
993−**Example:**
994−
995−```
996−~your-urbit:dojo> now
997−~2016.3.21..21.10.57..429a
998−```
999−
1000−#### `our`
1001−
1002−The current urbit ship. Read-only.
1003−
1004−**Example:**
1005−
1006−```
1007−~your-urbit:dojo> our
1008−~your-urbit
1009−```
1010−
1011−#### `eny`
1012−
1013−512 bits of entropy. Read-only.
1014−
1015−**Example:**
1016−
1017−```
1018−~your-urbit:dojo> eny
1019−\/0vnt.d474o.gpahj.jcf3o.448fh.2lamb.82ljm.8ol8u.b02vi.mrvvp.b7et2.knb7m.l8he\/
1020− 8.8qb9s.drm36.77n9b.a0qst.30g03.l5lb5.nvsbc.v39tn
1021−\/
1022−```
1023−
1024−### Troubleshooting
1025−
1026−If you encounter `%dy-edit-busy` while entering commands, it is
1027−because your Dojo is blocked on a timer or an HTTP request. Type backspace
1028−and your Dojo will end the blocked command.
1029−
1030−
1031−## Filesystem {#filesystem}
1032−
1033−Urbit has its own revision-controlled filesystem, Clay. Clay is a typed, global,
1034−referentially transparent namespace. An easy way to think about it is like typed
1035−`git`.
1036−
1037−The most common way to use Clay is to mount a Clay node in a Unix directory. The mounted directory is always at the root of your pier directory.
1038−
1039−### Quickstart
1040−
1041−This quick-start guide will walk you through some common commands. Follow along
1042−using your Dojo. When you get a `>=` message after entering a command, this means
1043−that the command was successful.
1044−
1045−It's important to note that whenever you want to sync changes from your Unix
1046−directory to your ship, you must use the `|commit %desk` command, where `%desk`
1047−is the desk that you'd like to sync to.
1048−
1049−When developing it's a good idea to use a separate desk. Create a `%sandbox`
1050−desk based on the `%home` desk:
1051−
1052−```
1053−~your-urbit:dojo> |merge %sandbox ~your-urbit %home
1054−```
1055−
1056−Running `our` produces your ship-name, meaning that you can run the following
1057−command instead of typing out the entire thing. Useful for comets due to their
1058−very long names.
1059−
1060−```
1061−~your-urbit:dojo> |merge %sandbox our %home
1062−```
1063−
1064−Most of the time we want to use Clay from Unix. Mount the entire contents of
1065−your `sandbox` desk to Unix:
1066−
1067−```
1068−~your-urbit:dojo> |mount /=sandbox=
1069−```
1070−
1071−To explore the filesystem from inside Urbit `+ls` and `+cat` are useful. `+ls`
1072−displays files in the current directory, and `+cat` displays the contents of
1073−a file.
1074−
1075−We can use `%` to mean "current directory." The result of the command below
1076−is just like using `ls` in a Unix terminal.
1077−
1078−```
1079−~your-urbit:dojo> +ls %
1080−```
1081−
1082−Notice how `+cat %` does the same thing. That's because everything in Clay,
1083−including directories, is a file.
1084−
1085−Sync from your friend `~some-ship`'s `%experiment` desk to your
1086−`%sandbox` desk:
1087−
1088−```
1089−~your-urbit:dojo> |sync %sandbox ~some-ship %experiment
1090−```
1091−
1092−If and when your sync is successful, you will receive a message:
1093−
1094−```
1095−activated sync from %experiment on ~some-ship to %sandbox
1096−```
1097−
1098−The ship that you sync from will get their own message indicating that you're
1099−both connected as peers:
1100−
1101−```
1102−; ~your-urbit is your neighbor.
1103−```
1104−
1105−---
1106−
1107−### Clay manual
1108−
1109−#### Paths
1110−
1111−A path in Clay is a list of URL-safe text, restricted to the characters
1112−`[a z]`,`[0 9]`, `.`, `-`, `_`, and `~`. Formally this is a `(list knot)`,
1113−meaning that each segment, delineated by `/`, is of the `knot` ASCII-text type.
1114−In other words, paths are expressed as `/foo/bar/baz`. File extensions are
1115−separated from file names with `/`, not `.`. Extensions are syntactically
1116−identical to subdirectories, except that they must terminate the path.
1117−
1118−Paths begin with a piece of data called a `beak`. A beak is formally a
1119−`(p=ship q=desk r=case)`; it has three components, and might look like
1120−`/~dozbud-namsep/home/11`.
1121−
1122−The first `beak` component is `ship`, which is, as you might guess, the name of
1123−an Urbit ship. The second component is `desk`, which is a workspace meant to
1124−contain other directories; the default desk is `%home`. The third component is
1125−`case`, which represents version information in various ways: date and time;
1126−a version sequence, which is a value incremented by one whenever a file on the
1127−given `desk` is modified; or an arbitrary plaintext label.
1128−
1129−You can find what your `beak` is at any given moment by
1130−typing `%` in the Dojo and looking at the first three results.
1131−
1132−We use `beak`s because, unlike the current internet, the Urbit network uses a
1133−global namespace. That means that a file named `example.hoon` in the `/gen`
1134−directory on the `%home` desk of your ship `~lodleb-ritrul` would have a
1135−universal address to anyone else on the network:
1136−`/~lodleb-ritrul/home/186/gen/example/hoon`. That, of
1137−course, doesn't mean that everyone on the network has privileges to access that
1138−path.
1139−
1140−The structure that combines a `beak` with further path information is called a
1141−`beam`.
1142−
1143−#### Relative paths
1144−
1145−The `%` command, which we gestured at in the above section, represents the
1146−**relative path**, which is the path where you are currently working. If your
1147−working directory is just your home desk, indicated by the
1148−prompt `~your-planet:dojo>`, then running the command below will print your
1149−working directory's `beam` information: your `beak`, and a `~` that represents
1150−the empty list since no path is present.
1151−
1152−```
1153−~your-urbit:dojo> %
1154−```
1155−
1156−`%`s can be stacked to indicate one level further up in the hierarchy for each
1157−additional `%`. Try the following command:
1158−
1159−```
1160−~your-planet:dojo> %%%
1161−```
1162−
1163−You'll probably notice that it only has your ship name and the empty list. The
1164−two additional `%`s abandoned the `case` and the `desk` information by moving
1165−up twice the hierarchy.
1166−
1167−There are no local relative paths. `/foo/bar` must be written as
1168−`%/foo/bar`.
1169−
1170−#### Substitution
1171−
1172−You don't need to write out the explicit path every time you want to reference
1173−somewhere outside of your working directory. You can substitute `=` for the
1174−segments of a path.
1175−
1176−Recall that a full address in the the Urbit namespace is a `beam`: the
1177−`/ship/desk/case/path`. If you've switched to another desk before, you're
1178−already familiar with substitution syntax:
1179−
1180−```
1181−~your-urbit:dojo> =dir /=sandbox=
1182−```
1183−
1184−The above command uses substitution to use your current `ship` and
1185−`case`; only the `desk` argument, which is located between the other two, is
1186−given something new. Without substitution, you would need to write:
1187−
1188−```
1189−~your-urbit:dojo> =dir /~your-urbit/sandbox/85
1190−```
1191−
1192−Substitutions work the same way in `beak`s (the `ship/desk/case` part) and
1193−paths. For example, if you are in the `/gen` directory, you can reference a file
1194−in the `/app` directory like below. (`+cat` displays the contents of a file).
1195−
1196−```
1197−~your-urbit:dojo> =dir %/gen
1198−~your-urbit:dojo/=/=/~2018.10.2..00.35.44..d7e8/gen> +cat /===/app/curl/hoon
1199−```
1200−
1201−Note what was substituted out, and note that we don't need to separate `=` with
1202−`/`.
1203−
1204−If we changed our working directory to something called `/gen/gmail`, we could
1205−access a file called
1206−
1207−```
1208−~your-urbit:dojo/=/=/~2018.10.2..00.35.44..d7e8/gen> =dir %/gmail
1209−~your-urbit:dojo/=/=/~2018.10.2..00.35.44..d7e8/gen/gmail> +cat /===/app/=/split/hoon
1210−```
1211−
1212−Because both paths share a directory named `/gmail` at the same position in the
1213−address hierarchy – which, if you recall, is just a `list` – the above command
1214−works!
1215−
1216−We can do the same thing between desks. If `%sandbox` has been merged with
1217−`%home`, the following command will produce the same results as the above
1218−command.
1219−
1220−```
1221−~your-urbit:dojo/=/=/~2018.10.2..00.35.44..d7e8/gen/gmail> +cat /=sandbox=/app/=/split/hoon
1222−```
1223−
1224−Most commonly this is used to avoid having to know the current revision
1225−number in the `dojo`: `/~lodleb-ritrul/home/~2018.10.2..00.35.44..d7e8/gen/example/hoon`
1226−
1227−#### Changing directories
1228−
1229−Change the working directory with `=dir`. It's our equivalent of the Unix `cd`.
1230−
1231−For example, the syntax to navigate to `/home/gen/ask` is:
1232−
1233−```
1234−~your-urbit:dojo> =dir /=home=/gen/ask
1235−```
1236−
1237−This command will turn your prompt into something like this:
1238−
1239−```
1240−~your-urbit:dojo/=/=/~2018.10.2..00.35.44..d7e8/gen/ask>
1241−```
1242−
1243−Using `=dir` without anything else uses the null path, which returns you to
1244−your home desk.
1245−
1246−```
1247−~your-urbit:dojo/=/=/~2018.10.2..00.35.44..d7e8/gen/ask> =dir
1248−```
1249−
1250−Your dojo prompt will turn back into `~your-urbit:dojo>`.
1251−
1252−To go up levels in the path hierarchy, recall the relative path expression
1253−`%`. Stacking them represents another level higher in the hierarchy than
1254−the current working directory for each `%` beyond the initial. The command below
1255−brings you one level up:
1256−
1257−```
1258−~your-urbit:dojo> =dir %/gen
1259−~your-urbit:dojo/=/=/~2018.10.2..00.35.44..d7e8/gen> =dir %%
1260−```
1261−
1262−### Revision-control
1263−
1264−#### Mount
1265−
1266−Syntax: `|mount /clay/path [Unix-name]`
1267−
1268−Mount the `clay-path` at the Unix mount point `Unix-name`.
1269−
1270−**Examples:**
1271−
1272−```
1273−|mount %/gen generators
1274−```
1275−
1276−Mounts `%/gen` to `/generators` inside your pier directory.
1277−
1278−#### Unmount
1279−
1280−```
1281−|unmount [clay-path || Unix-name]
1282−```
1283−
1284−Unmount the path or name from Unix.
1285−
1286−**Examples:**
1287−
1288−```
1289−|unmount %/gen
1290−```
1291−
1292−Unmounts the Clay path `%/gen` from whatever name it was mounted as.
1293−
1294−```
1295−|unmount %generators
1296−```
1297−
1298−Unmounts the Unix path `/generators`.
1299−
1300−#### Merge
1301−
1302−```
1303−|merge desk beak[, =gem strategy]
1304−```
1305−
1306−Merges a `beak` into a `desk` using an optional merge `strategy`.
1307−
1308−A `beak` is a ship-desk-case triple, encoded as a
1309−path(`/~dozbud/home/2`)
1310−
1311−**Examples:**
1312−
1313−```
1314−|merge %home-work /=home=, =gem %fine
1315−```
1316−
1317−Merge `/=home=` into `%home-work` using merge strategy `%fine`.
1318−
1319−```
1320−|merge %examples ~wacbex-ribmex %examples
1321−```
1322−
1323−Merge the `%examples` desk from `~waxbex-ribmex`
1324−
1325−#### Sync
1326−
1327−```
1328−|sync desk plot [plot-desk]
1329−```
1330−
1331−Subscribe to continuous updates from remote `plot` on local `desk`.
1332−`plot-desk` can specify the remote `desk` name. When omitted it defaults
1333−to being the same as `desk`. Non-comet urbits have
1334−`|sync %home ~parent %kids` automatically set up (where `~parent` is the
1335−planet that issued a moon, the star that issued a planet, or the galaxy
1336−that issued a star).
1337−
1338−**Examples:**
1339−
1340−```
1341−|sync %home-local ~dozbud %home
1342−
1343−|sync %home ~doznec
1344−```
1345−
1346−#### Unsync
1347−
1348−```
1349−|unsync desk plot [plot-desk]
1350−```
1351−
1352−Unsubscribe from updates from remote `plot` on local `desk` with
1353−optional `plot-desk`. Arguments must match original `|sync` command.
1354−
1355−Example:
1356−
1357−```
1358−|unsync %home-local ~dozbud %home
1359−```
1360−
1361−#### Label
1362−
1363−```
1364−|label desk name
1365−```
1366−
1367−Label the current version of `desk` `name`.
1368−
1369−Example:
1370−
1371−```
1372−|label %home release
1373−```
1374−
1375−### Merge strategies
1376−
1377−See [Clay merge strategies](@/docs/tutorials/arvo/clay.md#merge-strategies).
1378−
1379−### Manipulation
1380−
1381−#### `+cat`
1382−
1383−Syntax: `+cat path [path ...]`
1384−
1385−Similar to Unix `cat`. `+cat` takes one or more `path`s, and prints their
1386−contents. If that `path` is a file, the contents of the file is printed. If the
1387−`path` terminates in a directory, the list of names at that path is produced.
1388−
1389−#### `+ls`
1390−
1391−Syntax: `+ls path`
1392−
1393−Similar to Unix `ls`. `+ls` takes a single `path`.
1394−
1395−Produces a list of names at the `path`.
1396−
1397−```
1398−~your-urbit:dojo> +cat %/our/home/gen/curl/hoon
1399−```
1400−
1401−#### `|rm`
1402−
1403−Syntax: `|rm path`
1404−
1405−Remove the data at `path`. `Path` must be a path to the actual node, not a
1406−'directory'.
1407−
1408−#### `|cp`
1409−
1410−Syntax: `|cp to from`
1411−
1412−Copy the file at `from` into the path `to`.
1413−
1414−#### `|mv`
1415−
1416−Syntax: `|mv to from`
1417−
1418−Move the file at `from` into the path `to`.
1419−
1420−In Clay, `|mv` is just a shorthand for `|cp` then `|rm`. The `|rm`
1421−doesn't happen unless the `|cp` succeeds.