mirror of
https://github.com/OpenBB-finance/OpenBB.git
synced 2026-11-03 16:02:04 +00:00
4ad995fdd0
* add first iteration of content for Terminal Pro * Update index.md * Update dashboards.md * Update folders.md * Update grouping.md * Update report.md * Update templates.md * Update quick-start.md * Update index.md * Update index.md * Update home.md * Update news.md * Update index.md * Update index.md * Update index.md * Update data-provider.md * Update chat-with-widget.md * Update data-manipulation.md * Update forecasting.md * fix: images self closing tags * fix: only pro visitors can see pro * inter font * improve SEO content and restructuring * add new package for toggle on tutorials * move folder around * improve main page of each prod * small updates and improvements * fix logo above * small improvement in headtitle for portfolio funcs * fix typos from OpenAI's GPT-4 * fix _category_ json * remove generic SEO words * add script that generates SEO for documentation * add missing file * remove sdk warning message * fix links for andrew --------- Co-authored-by: jose-donato <zmcdonato@gmail.com> Co-authored-by: jose-donato <43375532+jose-donato@users.noreply.github.com> Co-authored-by: andrewkenreich <andrew.kenreich@gmail.com>
35 lines
787 B
Markdown
Vendored
35 lines
787 B
Markdown
Vendored
---
|
|
title: rs
|
|
description: Learn how to display a repository summary by using the rs command. A
|
|
simple guide to understanding the rs usage and its parameters. Source code is available
|
|
on Github.
|
|
keywords:
|
|
- repo summary
|
|
- repository
|
|
- rs command
|
|
- Github
|
|
- openbb-finance/openbbterminal
|
|
---
|
|
|
|
import HeadTitle from '@site/src/components/General/HeadTitle.tsx';
|
|
|
|
<HeadTitle title="alt/oss/rs - Reference | OpenBB Terminal Docs" />
|
|
|
|
Display a repo summary [Source: https://api.github.com]
|
|
|
|
### Usage
|
|
|
|
```python
|
|
rs -r REPO
|
|
```
|
|
|
|
---
|
|
|
|
## Parameters
|
|
|
|
| Name | Description | Default | Optional | Choices |
|
|
| ---- | ----------- | ------- | -------- | ------- |
|
|
| repo | Repository to search for repo summary. Format: org/repo, e.g., openbb-finance/openbbterminal | None | False | None |
|
|
|
|
---
|