Skip to content

Commit

Permalink
fix table rendering in CLI docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@m-vdb
m-vdb committed Sep 22, 2023
1 parent f18d45e commit 7faf9c4
Showing 1 changed file with 28 additions and 31 deletions.
59 changes: 28 additions & 31 deletions docs/docs/command-line-interface.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,37 +12,34 @@ import RasaProBanner from "@theme/RasaProBanner";

## Cheat Sheet

The following commands are relevant to all assistants built with Rasa.

| Command | Effect |
| ------------------------- | -------------------------------------------------------------------------------------------------- |
| `rasa init` | Creates a new project with example training data, actions, and config files. |
| `rasa train` | Trains a model using your NLU data and stories, saves trained model in `./models`. |
| `rasa shell` | Loads your trained model and lets you talk to your assistant on the command line. |
| `rasa run` | Starts a server with your trained model. |
| `rasa run actions` | Starts an action server using the Rasa SDK. |
| `rasa test e2e` | Runs end-to-end testing fully integrated with the action server that serves as acceptance testing. |
| `rasa data split nlu` | Performs a 80/20 split of your NLU training data. |
| `rasa data validate` | Checks the domain, NLU and conversation data for inconsistencies. |
| `rasa export` | Exports conversations from a tracker store to an event broker. |
| `rasa evaluate markers` | Extracts markers from an existing tracker store. |
| `rasa marker upload` | Upload marker configurations to Analytics Data Pipeline |
| `rasa license` | Display licensing information. |
| `rasa -h` | Shows all available commands. |


The following commands are only relevant if you are building [NLU-based assistants](./calm.mdx#calm-compared-to-nlu-based-assistants).

| Command | Effect |
| ------------------------- | -------------------------------------------------------------------------------------------------- | |
| `rasa interactive` | Starts an interactive learning session to create new training data by chatting to your assistant. |
| `rasa visualize` | Generates a visual representation of your stories. |
| `rasa test` | Tests a trained Rasa model on any files starting with `test_`. |
| `rasa data split stories` | Do the same as `rasa data split nlu`, but for your stories data. |
| `rasa data convert` | Converts training data between different formats. |
| `rasa data migrate` | Migrates 2.0 domain to 3.0 format. |


The following commands are relevant to all assistants built with Rasa.

| Command | Effect |
| ----------------------- | -------------------------------------------------------------------------------------------------- |
| `rasa init` | Creates a new project with example training data, actions, and config files. |
| `rasa train` | Trains a model using your NLU data and stories, saves trained model in `./models`. |
| `rasa shell` | Loads your trained model and lets you talk to your assistant on the command line. |
| `rasa run` | Starts a server with your trained model. |
| `rasa run actions` | Starts an action server using the Rasa SDK. |
| `rasa test e2e` | Runs end-to-end testing fully integrated with the action server that serves as acceptance testing. |
| `rasa data split nlu` | Performs a 80/20 split of your NLU training data. |
| `rasa data validate` | Checks the domain, NLU and conversation data for inconsistencies. |
| `rasa export` | Exports conversations from a tracker store to an event broker. |
| `rasa evaluate markers` | Extracts markers from an existing tracker store. |
| `rasa marker upload` | Upload marker configurations to Analytics Data Pipeline |
| `rasa license` | Display licensing information. |
| `rasa -h` | Shows all available commands. |

The following commands are only relevant if you are building [NLU-based assistants](./calm.mdx#calm-compared-to-nlu-based-assistants).

| Command | Effect |
| ------------------------- | ------------------------------------------------------------------------------------------------- |
| `rasa interactive` | Starts an interactive learning session to create new training data by chatting to your assistant. |
| `rasa visualize` | Generates a visual representation of your stories. |
| `rasa test` | Tests a trained Rasa model on any files starting with `test_`. |
| `rasa data split stories` | Do the same as `rasa data split nlu`, but for your stories data. |
| `rasa data convert` | Converts training data between different formats. |
| `rasa data migrate` | Migrates 2.0 domain to 3.0 format. |

:::note
If you run into character encoding issues on Windows like: `UnicodeEncodeError: 'charmap' codec can't encode character ...` or
Expand Down

0 comments on commit 7faf9c4

Please sign in to comment.