summaryrefslogtreecommitdiffstats
path: root/website/content/cli/routines/community-routines.md
blob: 1fa10fcdd048c5396e9c0ded31e9a69a3c3a89b7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
---
title: Community Routines
sidebar_position: 3
description: Page provides a detailed overview of OpenBB's Community
  Routines. It explains how users can create, modify, share, vote, download, and search for investment
  research scripts.
keywords:
- Community Routines
- Investment Research
- Investment Scripts
- Upvotes
- Share Scripts
- Advanced Search
- CLI
- automation
- Hub
---

import HeadTitle from '@site/src/components/General/HeadTitle.tsx';

<HeadTitle title="Community Routines - Routines - | OpenBB CLI Docs" />

## Overview

Community Routines are a feature of the [OpenBB Hub](https://my.openbb.co) that provides methods for creating, editing and sharing OpenBB CLI scripts in the cloud.

Users can create routines that are private or public, with public routines able to run directly from a URL.

## Create Routines

- From the sidebar, click on "My Routines".
- Scroll down and click the button, "Create New".
- Enter a name for the routine.
- Select the "public" check box to make it runnable via URL.
- Add tags (optional).
- Add a short description.
- Enter your workflow into the Script box.
- Click the "Create" button.

## Run From URL

To run a routine with a URL, it must be made public. Existing routines can be modified by clicking on the item under, "My Routines". Check the "Public" box to activate.

The URL will follow the pattern, `https://my.openbb.co/u/{username}/routine/{routine-name}`, which can be executed from the CLI with:

```console
/exe --url {URL}
```

## Download

Alternatively, click the "Download" button at the bottom of the routine editor to manually download the file to the machine. Place the file in the `OpenBBUserData/routines` folder and open the CLI. The script will be presented as a choice by auto-complete.