Skip to content

Commit

Permalink
Add doc for create_config
Browse files Browse the repository at this point in the history
  • Loading branch information
arjbingly committed Apr 30, 2024
1 parent ac5fcc5 commit 2a4e77c
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions src/docs/get_started.config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,14 @@ Configuration
GRAG gives the user an option to use a config file, in the form of a ``config.ini``.
The use of a config file streamlines the process of passing arguments to the various components in the code.

Generate Config file
**********************
To generate a starters config file with default values, run the below command at the location you want the config file.

``
python -m grag.components.create_config
``

File Resolution
****************
GRAG takes the closest ``config.ini`` to the file you run. This enables users to have multiple config files per project,
Expand Down

0 comments on commit 2a4e77c

Please sign in to comment.