Zulip Help

https://zulip.com/help/
Admin
Official help and documentation for Zulip, a powerful open-source team collaboration platform with...
Tokens:131,622
Snippets:1,539
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Install Zulip Desktop beta via APT (fresh install)

Source: https://zulip.com/help/desktop-app-install-guide

Use when Zulip Desktop is not installed. Sets up the beta APT repository and signing key, then installs the Zulip beta client.

```bash
sudo curl -fL -o /etc/apt/trusted.gpg.d/zulip-desktop.asc \
    https://download.zulip.com/desktop/apt/zulip-desktop.asc
echo "deb https://download.zulip.com/desktop/apt beta main" | \
    sudo tee /etc/apt/sources.list.d/zulip-desktop.list
sudo apt update
sudo apt install zulip
```

--------------------------------

### Run an existing Zulip bot

Source: https://zulip.com/help/running-bots

Install the zulip_bots package, start an existing bot with zulip-run-bot, and verify it is running by checking for the expected startup log line.

```bash
pip3 install zulip_bots
```

```bash
zulip-run-bot <bot-name> --config-file ~/path/to/zuliprc
```

```text
INFO:root:starting message handling...
```

--------------------------------

### Install zulip_botserver package

Source: https://zulip.com/help/deploying-bots

Installs the `zulip_botserver` package.

```bash
pip3 install zulip_botserver
```

--------------------------------

### Run a custom Zulip bot

Source: https://zulip.com/help/running-bots

Install the zulip_bots package, start a custom bot by passing its Python file to zulip-run-bot, and verify it is running by checking for the expected startup log line. Use --bot-config-file to provide a third-party configuration file if needed.

```bash
pip3 install zulip_bots
```

```bash
zulip-run-bot ~/path/to/my_bot.py --config-file ~/path/to/zuliprc
```

```text
INFO:root:starting message handling...
```

--------------------------------

### Install Zulip desktop app via Snap

Source: https://zulip.com/help/desktop-app-install-guide

Installs the Zulip desktop app via Snap. Requires snapd to be installed first. After installation, run Zulip from the app launcher or with `zulip` from a terminal.

```bash
sudo snap install zulip
```

--------------------------------

### Switch Zulip Desktop APT repository to beta

Source: https://zulip.com/help/desktop-app-install-guide

Use when Zulip Desktop is already installed. Switches the APT repository from stable to beta, then updates and installs the Zulip beta client.

```bash
sudo sed -i s/stable/beta/ /etc/apt/sources.list.d/zulip-desktop.list
sudo apt update
sudo apt install zulip
```

--------------------------------

### usage method example

Source: https://zulip.com/help/interactive-bots-api

Example implementation of the usage method from zulip_bots/bots/followup/followup.py. Returns a string describing the bot's functionality and includes a prerequisite to create a channel named 'followup'.

```python
def usage(self):
    return '''
        This plugin will allow users to flag messages
        as being follow-up items.  Users should preface
        messages with "@followup".
        Before running this, make sure to create a channel
        called "followup" that your API user can send to.
        '''

```

--------------------------------

### Install development version of Zulip bots package

Source: https://zulip.com/help/writing-bots

Steps to clone the python-zulip-api repository, navigate into it, and install all requirements in a Python virtualenv using the provision tool. The provision process installs the zulip, zulip_bots, and zulip_botserver packages in developer mode, allowing modifications without re-installing.

```bash
git clone https://github.com/zulip/python-zulip-api.git

```

```bash
cd python-zulip-api

```

```bash
python3 ./tools/provision

```

--------------------------------

### Zulip Markdown bulleted list example

Source: https://zulip.com/help/bulleted-lists

Example of Zulip Markdown bulleted list syntax. Use *, -, or + at the start of a line, and add two spaces before a bullet to create a nested list. Sub-sub-bullets start with four spaces. Multi-line bullets are supported.

```markdown
* bulleted lists
  * with sub-bullets too
  * sub-bullets start with 2 spaces
    * start sub-sub-bullets with 4 spaces
* multi
line
bullet
- dashes and
+ pluses are ok too

```

--------------------------------

### Install Zulip desktop app via APT

Source: https://zulip.com/help/desktop-app-install-guide

Sets up the Zulip Desktop APT repository and its signing key, then installs the Zulip client on Ubuntu or Debian. The app will be updated automatically during regular system updates (e.g., with `sudo apt update && sudo apt upgrade`).

```bash
sudo apt install curl
sudo curl -fL -o /etc/apt/trusted.gpg.d/zulip-desktop.asc \
    https://download.zulip.com/desktop/apt/zulip-desktop.asc
echo "deb https://download.zulip.com/desktop/apt stable main" | \
    sudo tee /etc/apt/sources.list.d/zulip-desktop.list
sudo apt update
sudo apt install zulip
```

--------------------------------

### Install and run Zulip desktop app via Flathub

Source: https://zulip.com/help/desktop-app-install-guide

Installs and runs the Zulip desktop app via Flathub. Requires Flatpak to be installed on the system. The first command installs the app from the official Flathub page, and the second runs it after installation.

```bash
flatpak install flathub org.zulip.Zulip
```

```bash
flatpak run org.zulip.Zulip
```

--------------------------------

### Configuration file example

Source: https://zulip.com/help/interactive-bots-api

Configuration file for the bot. Contains the API key, email, and site URL. The site is your development environment URL, e.g., localhost:9991.

```ini
[api]
key=<api-key>
email=<email>
site=<dev-url>
```

--------------------------------

### Create a to-do list with Markdown: /todo command

Source: https://zulip.com/help/collaborative-to-do-lists

Use the /todo command in the compose box to create a to-do list. Type /todo followed by a space and the title. Optionally, type each task on a new line with its description after a colon and blank space.

```markdown
/todo Today's tasks
Task 1: This is the first task.
Task 2: This is the second task.
Last task
```
Tokens:
Raw