Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update docs #316

Merged
merged 1 commit into from
Oct 13, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 57 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,62 @@ Yoda is designed to be extensible. You can write your own plugins or use the AI

The help command will list all the available plugins.

```bash
$ yoda --help
```

![img.png](docs/docs/img.png)
❯ yoda --help

Usage: yoda [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────╮
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to │
│ copy it or customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ ai AI command. Allows you to communicate with your local LLMs │
│ config Config management │
│ dev │
│ init Init yoda configurations │
│ plugin Commands to manage plugins │
│ url │
╰──────────────────────────────────────────────────────────────────────────╯
```

You can find the details for each plugin with the `--help` flag. Some examples:

![img_1.png](docs/docs/img_1.png)

![img_2.png](docs/docs/img_2.png)
```
❯ yoda ai --help

Usage: yoda ai [OPTIONS] COMMAND [ARGS]...

AI command. Allows you to communicate with your local LLMs

╭─ Options ────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ chat Chat with the AI model based on the provided prompt. │
│ generate-command Generate code for a new plugin command based on the │
│ provided prompt. │
╰──────────────────────────────────────────────────────────────────────────╯
```

![img_3.png](docs/docs/img_3.png)
```
❯ yoda dev --help

Usage: yoda dev [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ checksite Check if a site is up and running │
│ coinflip Flip a coin! │
│ generatepassword Generates a secure password │
│ speedtest Test your internet connection │
│ whois Check whois info for a domain name │
╰──────────────────────────────────────────────────────────────────────────╯
```

### Write your own plugin for Yoda

Expand Down Expand Up @@ -121,7 +164,12 @@ def weather(location: str, units: Optional[str] = None):
```

.. or chat with Yoda:
![img_5.png](docs/docs/img_5.png)

```bash
❯ yoda ai chat "How are you?"
🤖 AI response:
I am well, young one. The Force is strong with me.
```

## Development setup

Expand Down
21 changes: 21 additions & 0 deletions docs/docs/config.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Config Management

```
❯ yoda config --help

Usage: yoda config [OPTIONS] COMMAND [ARGS]...

Config management

╭─ Options ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ get Get value of a key set in yoda config │
│ init Initializes a sqlite db that will store the config │
│ list List all key-value pairs in the config │
│ set Set a value for a key in config │
╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```

::: yodapa.core.config
Binary file removed docs/docs/img.png
Binary file not shown.
Binary file removed docs/docs/img_1.png
Binary file not shown.
Binary file removed docs/docs/img_2.png
Binary file not shown.
Binary file removed docs/docs/img_3.png
Binary file not shown.
Binary file removed docs/docs/img_5.png
Binary file not shown.
66 changes: 57 additions & 9 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,19 +29,62 @@ Yoda is designed to be extensible. You can write your own plugins or use the AI

The help command will list all the available plugins.

```bash
$ yoda --help
```

![img.png](img.png)
❯ yoda --help

Usage: yoda [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────╮
│ --install-completion Install completion for the current shell. │
│ --show-completion Show completion for the current shell, to │
│ copy it or customize the installation. │
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ ai AI command. Allows you to communicate with your local LLMs │
│ config Config management │
│ dev │
│ init Init yoda configurations │
│ plugin Commands to manage plugins │
│ url │
╰──────────────────────────────────────────────────────────────────────────╯
```

You can find the details for each plugin with the `--help` flag. Some examples:

![img_1.png](img_1.png)

![img_2.png](img_2.png)
```
❯ yoda ai --help

Usage: yoda ai [OPTIONS] COMMAND [ARGS]...

AI command. Allows you to communicate with your local LLMs

╭─ Options ────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ chat Chat with the AI model based on the provided prompt. │
│ generate-command Generate code for a new plugin command based on the │
│ provided prompt. │
╰──────────────────────────────────────────────────────────────────────────╯
```

![img_3.png](img_3.png)
```
❯ yoda dev --help

Usage: yoda dev [OPTIONS] COMMAND [ARGS]...

╭─ Options ────────────────────────────────────────────────────────────────╮
│ --help Show this message and exit. │
╰──────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────╮
│ checksite Check if a site is up and running │
│ coinflip Flip a coin! │
│ generatepassword Generates a secure password │
│ speedtest Test your internet connection │
│ whois Check whois info for a domain name │
╰──────────────────────────────────────────────────────────────────────────╯
```

### Write your own plugin for Yoda

Expand Down Expand Up @@ -121,7 +164,12 @@ def weather(location: str, units: Optional[str] = None):
```

.. or chat with Yoda:
![img_5.png](img_5.png)

```bash
❯ yoda ai chat "How are you?"
🤖 AI response:
I am well, young one. The Force is strong with me.
```

## Development setup

Expand Down
3 changes: 0 additions & 3 deletions docs/docs/modules.md

This file was deleted.

Loading
Loading