using/messaging.md · urbit.org

git.iko.soy/urbit.org

on 39bc0ab help sign in

urbit.org/using/messaging.md

315 lines 7.8 kB history raw

1+++

2title = "Messaging"

3weight = 2

4template = "doc.html"

5+++

7Chat (also called "chat-cli") is the built-in messaging app for Urbit.

9For the time being come join us in `~dopzod/urbit-help` by using the

10'quickstart' section below. `~dopzod` is the host ship, and `/urbit-help` is the

11channel on that ship.

13### Quickstart

15The most common uses of `:chat-cli` right now are communicating over a public chat channel on `~dopzod/urbit-help`, and sending direct messages. Everyone is more than welcome in `~dopzod/urbit-help`. It's the place to get help, ask questions and chat about Urbit in general.

17There are two ways of using `:chat-cli`: from the terminal running the Urbit process, or through the Landscape web UI available from your ship’s URL address, mentioned earlier in this guide.

19### Joining a chat

21In `:chat-cli`, any kind of medium for a message is called a _chat_. There are four types of chats: the _channel_ (public with blacklist), _village_ (private with whitelist), the _journal_ (publicly readable, privately writable), and the _mailbox_ (privately readable, publicly writable). 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 [manual](#messaging-manual) section later on.

23Let's join the `~dopzod/urbit-help` channel. Use `ctrl-x` to switch from the Dojo prompt to the Chat prompt.

25Then:

27```

28~your-urbit:chat-cli> ;join ~dopzod/urbit-help

29```

31Scrolling down your terminal window, you'll probably see a playback of previous `~dopzod/urbit-help` messages that you missed. You c

33Post a line to `~dopzod/urbit-help:`

35```

36~your-urbit:chat-cli= Hello, world!

37```

39You'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:

43Glyphs 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.

45```

46~your-urbit:chat-cli= ;+

47~your-urbit:chat-cli+

48```

50Use `;leave` to unsubscribe from a channel:

52```

53~your-urbit:chat-cli= ;leave ~dopzod/urbit-help

54```

56Now, let's create a channel we can invite some friends to:

58```

59~your-urbit:chat-cli= ;create channel /my-channel

60```

62Now you can tell your friends to `;join ~your-urbit/my-channel`.

64### Direct messaging

66To send a direct message to someone, first set your audience:

68```

69~your-urbit:chat-cli= ;~talsur-todres

70```

72You'll see your prompt change:

74```

75~your-urbit:chat-cli[~talsur-todres]

76```

78Now you and `~talsur-todres` can exchange messages directly.

80```

81~your-urbit:chat-cli[~talsur-todres] Hey buddy!

82```

84To set your audience back to `~dopzod/urbit-help`:

86```

87~your-urbit:chat-cli[~talsur-todres] ;~dopzod/urbit-help

88```

90You'll see your prompt change back:

92```

93~your-urbit:chat-cli=

94```

96#### Hoon

98You can use Chat to evaluate Hoon code and share the results with everyone in a chat. To do so, preface your Hoon with `#`.

100```

101~your-urbit:chat-cli= #(add 2 2)

102```

103

104will print as

105

106```

107~your-urbit# (add 2 2)

1084

109```

110

111### Creating and managing chats

112

113As 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.

114

115#### Create

116

117Syntax: `;create [type] /name +`, where `+` represents an optional glyph.

118

119Creates and joins a chat, where `[type]` is any of the following:

120- `channel`: public chat. Has a blacklist for write control.

121- `village`: invite-only chat.

122- `journal`: publicly readable, invite-only for writing.

123- `mailbox`: publicly writeable, can only be read by its host.

124

125Let's create an example mailbox: