using/admin.md · urbit.org

git.iko.soy/urbit.org

on 2f70e5f help sign in

urbit.org/using/admin.md

213 lines 6.7 kB history raw

1+++

2title = "Admin and Operations"

3weight = 2

4template = "doc.html"

5+++

6Your urbit (also called your _ship_) is a persistent Unix process that you

7mainly control from the console. For some things, a browser will also work.

9## Shutdown

11You can turn your urbit off with `Ctrl-d` from the Talk or Dojo prompts.

13You can force-quit your urbit with `Ctrl-z` from anywhere.

15## Restart

17To restart your urbit simply pass the name of your pier:

19```

20$ urbit some-planet

21```

23or

25```

26$ urbit comet

27```

29## Logging

31To log an urbit's command line output to a file, use `script`:

33```

34$ script urbit.log urbit your-urbit

35```

37## Moving your pier

39Piers are designed to be portable, but it _must_ be done while the urbit

40is turned off. Urbit networking is stateful, so you can't run two copies

41of the same urbit in two places.

43To move a pier, simply move the contents of the directory it lives in.

44To keep these files as small as possible we usually use the `--sparse`

45option in `tar`. With a pier `your-urbit/`, something like this should work:

47```

48tar -Scvzf ~/your-urbit.tar.gz ~/your-urbit/

49scp your-old-server:~/your-urbit.tar.gz your-new-server:~

50```

52Then to unzip it, on your other Unix server, run:

54```

55tar xfvz your-urbit.tar.gz

56```

58Delete the tar file, and, after installing Urbit on your new server,

59start your urbit back up with:

61```

62urbit your-urbit

63```

65## Console

67Your Urbit terminal is separated into two parts: the prompt (the bottom

68line) and the record (everything above that). The record is shared; all

69the output from all the apps in your command set appears in it. The

70prompt is multiplexed.

72In the CLI, Urbit apps can process your input before you hit return. To

73see this in action try entering `)` as the first character at the Dojo

74prompt. Since there is no Dojo command or Hoon expression that starts

75with ')', the Dojo rejects it.

77`Ctrl-x` - Switches the prompt between running console apps.

79`Ctrl-c` - Crash current event. Processed at the Unix layer and prints a stack.

80trace.

82`Ctrl-d` - From Talk or Dojo, stops your Urbit process.

84`Ctrl-z` - Stops the Urbit process from _anywhere_.

86`↑` / `↓` - History navigation.

88`Backspace` - Interrupts running commands. For example, if you have begun a multiline Hoon expression and then press backspace, it will discard the already-written code, or if you press backspace while a request is still pending it will cancel it and print `! cancel /hand`.

90The following emacs-style key bindings are available:

92```

93Ctrl-a Cursor to beginning of the line (Home)

94Ctrl-b Cursor one character backward (left-arrow)

95Ctrl-e Cursor to the end of the line (End)

96Ctrl-f Cursor one character forward (right-arrow)

97Ctrl-g Beep; cancel reverse-search

98Ctrl-k Kill to end of line

99Ctrl-l Clear the screen

100Ctrl-n Next line in history (down-arrow)

101Ctrl-p Previous line in history (up-arrow)

102Ctrl-r Reverse-search