aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 8 insertions, 4 deletions
diff --git a/README.md b/README.md
index d1e2ab5..4f9ad94 100644
--- a/README.md
+++ b/README.md
@@ -48,7 +48,7 @@ echo 'source ~/fms/integration.zsh' >> ~/.zshrc
## How to configure
-Each command is stored in the file commands.yaml. To add new commands or modify existing ones, edit commands.yaml with the following fields:
+Each command is stored in the file data/commands.yaml. To add new commands or modify existing ones, edit data/commands.yaml with the following fields:
```yaml
- cmd: <the command to insert in your prompt>
lang: <the language of your command, sh, ps1>
@@ -74,9 +74,14 @@ Then, to update the database and apply the changes, run the following commands:
Warning, this may take a long time.
-The Fast Memo Shell comes with a list of commands, but you are highly encouraged to update it according to your needs.
+# Populate database from Arsenal data
-The database provided as an example comes from a quick extract of the [Arsenal](https://github.com/Orange-Cyberdefense/arsenal) tool's database.
+The Fast Memo Shell can import data from the [Arsenal](https://github.com/Orange-Cyberdefense/arsenal) project, but you are highly encouraged to update it according to your needs.
+
+To generate a FMS-compatible commands.yaml file from Arsenal use, the following script:
+```
+./data/generate_arsenal_commands.sh
+```
## How to use
@@ -96,4 +101,3 @@ Fast Memo Shell can also display all available manuals. To switch between both m
* Allow more language like java, cmd .. (with adapted comment chars for description)
* Multithreaded update
-* Write a clean extractor for Arsenal \ No newline at end of file