docs/using/shell.md · urbit.org

git.iko.soy/urbit.org

on 4ff1e79 help sign in

urbit.org/docs/using/shell.md

277 lines 6.8 kB history raw

1---

2navhome: /docs

3next: true

4sort: 5

5title: Shell (:dojo)

6---

8# Shell (`:dojo`)

10<div class="row">

11<div class="col-md-8">

13The `:dojo` is the place to quickly experiment with Urbit. On

14the surface the `:dojo` is just a Hoon REPL. On the inside, the

15`:dojo` is a system for operating on and transforming data in

16Urbit.

18</div>

19</div>

21## Quickstart

23Evaluate a hoon expression:

25 ~your-urbit:dojo> (add 2 2)

26 ~your-urbit:dojo> %+ add 2 2

28Tall form Hoon may require multiple lines:

30 ~your-urbit:dojo> %+ add

31 ~your-urbit:dojo< 2

32 ~your-urbit:dojo< 2

34Use `=var` to save a shell variable:

36 ~your-urbit:dojo> =foo (add 2 2)

38Use `=dir` to set the current working directory:

40 ~your-urbit:dojo> =dir %/web

42Generators (files in `/gen`) are run with `+`:

44 ~your-urbit:dojo> +hello 'world'

46Save output to a file in `%clay` with `*`:

48 ~your-urbit:dojo> *some/file/path/hoon 'hello world'

50Run system commands from `:hood`, like `reload`, using `|`:

52 ~your-urbit:dojo> |reload %eyre

55### Generators

57**`+cat`** - Similar to Unix `cat`. Accepts a path.

59 ~your-urbit:dojo> +cat %/web/md

60 ~your-urbit:dojo> +cat /~talsur-todres/home/2/web/notes/md

62**`+curl`** - Similar to Unix `curl`. Accepts a `tape`.

64 ~your-urbit:dojo> +curl "http://nyt.com"

66**`+hello`** - Just prints the argument. Accepts a `@ta`.

68 ~your-urbit:dojo> +hello 'mars'

70**`+ls`** - Similar to Unix `ls`. Accepts a path.

72 ~your-urbit:dojo> +ls %/web

73 ~your-urbit:dojo> +ls /~talsur-todres/home/2/web/notes

75**`+moon`** - Generate a random moon from a planet. No arguments.

77**`+solid`** - Compile the current state of the kernel and output a noun. Usually downloaded to a file in unix. No arguments.

79 ~your-urbit:dojo> .urbit/pill +solid

81**`+ticket`** - Generate a ticket for an Urbit plot. Takes an Urbit name (`@p`).

83 ~your-urbit:dojo> +ticket ~talsur-todres-your-urbit

85**`+tree`** - Generate a recursive directory listing. Takes a path.

87 ~your-urbit:dojo> +tree %/web

89### Hood

91The hood is the system daemon. See `gen/hood` and `app/hood`.

93**`|hi`** - Sends a direct message. Sort of like Unix `write`. Accepts an urbit name (`@p`) and a string (`cord`).

95 ~your-urbit:dojo> |hi ~doznec 'you there?'

97**`|link`** / **`|unlink`** - Link / unlink a remote app. Accepts an Urbit name and an app name.

99 ~your-urbit:dojo> |link ~talsur-todres %octo

100

101**`|mass`** - Prints the current memory usage of all the kernel modules. No arguments.

102

103**`|reload`** - Reloads a kernel module (vane) from source. Accepts any number of vane names.

104

105 ~your-urbit:dojo> |reload %clay %eyre

106

107**`|reset`** - Reloads `hoon.hoon`. No arguments.

108

109**`|start`** - Starts an app. Accepts an app name.

110

111 ~your-urbit:dojo> |start %curl

112

113## Manual

114

115<h3 class="first child">Sources and sinks</h3>

116

117A dojo command is either a source or a sink. A source is just something that can be printed to your console or the result of some computation. A sink is an *effect*: a change to the filesystem, a network message, a change to your environment, or typed message to an app.

118

119Sources can be chained together, but we can only produce one effect per command.

120

121### Sinks

122

123#### `=` - Set variable

124

125Set any envronment variable:

126

127 ~your-urbit:dojo> =foo 42

128 ~your-urbit:dojo> (add 2 foo)

129