Skip to content

Commit 2f72878

Browse files
committed
format arguments as lists
1 parent 560b237 commit 2f72878

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

README.md

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ Creates an empty database. If no db is provided, the default is `promptlab.db`.
6161

6262
### Arguments
6363

64-
`--db` (optional) The name of the database file. Default is `promptlab.db`.
64+
- `--db` (optional) The name of the database file. Default is `promptlab.db`.
6565

6666
### Examples
6767

@@ -75,8 +75,8 @@ Loads a file or files into a new group, each of which contains a set of blocks.
7575

7676
### Arguments
7777

78-
`--fn` (required) The name of the file to load.
79-
`--group_tag` (optional) The tag of the group to create
78+
- `--fn` (required) The name of the file to load.
79+
- `--group_tag` (optional) The tag of the group to create
8080

8181
### Examples
8282

@@ -136,8 +136,8 @@ The `filter` command creates a new group of blocks by applying a filter to the c
136136

137137
### Arguments
138138

139-
`--where` (required) A SQL WHERE clause to filter the blocks in the current group.
140-
`--group_tag` (optional) The tag to use for the new group.
139+
- `--where` (required) A SQL WHERE clause to filter the blocks in the current group.
140+
- `--group_tag` (optional) The tag to use for the new group.
141141

142142
### Examples
143143

@@ -159,7 +159,7 @@ Lists all groups.
159159

160160
### Arguments
161161

162-
`--where` (optional) A SQL WHERE clause to filter the results
162+
- `--where` (optional) A SQL WHERE clause to filter the results
163163

164164
### Examples
165165

@@ -195,7 +195,7 @@ List all blocks in the current group:
195195

196196
### Arguments
197197

198-
`--where` (optional) A SQL WHERE clause to filter the results. Running `promplab blocks` will show the columns available for filtering. These are currently `['block_id', 'block_tag', 'parent_block_id', 'group_id', 'group_tag', 'block', 'token_count']`
198+
- `--where` (optional) A SQL WHERE clause to filter the results. Running `promplab blocks` will show the columns available for filtering. These are currently `['block_id', 'block_tag', 'parent_block_id', 'group_id', 'group_tag', 'block', 'token_count']`
199199

200200
### Examples
201201

@@ -223,9 +223,9 @@ Write blocks or prompts to standard output.
223223

224224
### Arguments
225225

226-
`--where` (optional) A SQL WHERE clause to filter the results. Running `promplab blocks` will show the columns available for filtering. These are currently `['block_id', 'block_tag', 'parent_block_id', 'group_id', 'group_tag', 'block', 'token_count']`
227-
`--source` (required) The source to dump. Options are `blocks` or `prompts`.
228-
`--delimiter` (optional) The delimiter to use when joining the blocks. Default is a newline.
226+
- `--source` (required) The source to dump. Options are `blocks` or `prompts`.
227+
- `--where` (optional) A SQL WHERE clause to filter the results. Running `promplab blocks` will show the columns available for filtering. These are currently `['block_id', 'block_tag', 'parent_block_id', 'group_id', 'group_tag', 'block', 'token_count']`
228+
- `--delimiter` (optional) The delimiter to use when joining the blocks. Default is a newline.
229229

230230
### Examples
231231

@@ -253,12 +253,12 @@ Generate prompts from a set of blocks based on metadata and a template, and then
253253

254254
### Arguments
255255

256-
`--prompt` (required) The name of the prompt template.
257-
`--where` (optional) A SQL WHERE clause to filter the blocks that will be used to create the prompts.
258-
`--model` (optional) The name of the openAI model to use. Defaults to gpt-4. You can see a list of models [here]https://platform.openai.com/docs/models/overview).
259-
`--prompt_tag` (optional) A tag to use for the prompt.
260-
`--globals` (optional) A YAML file with global metadata values that can be used in the prompt template.
261-
`--fake` (optional) Generates a fake response data (mostly for testing)
256+
- `--prompt` (required) The name of the prompt template.
257+
- `--where` (optional) A SQL WHERE clause to filter the blocks that will be used to create the prompts.
258+
- `--model` (optional) The name of the openAI model to use. Defaults to gpt-4. You can see a list of models [here]https://platform.openai.com/docs/models/overview).
259+
- `--prompt_tag` (optional) A tag to use for the prompt.
260+
- `--globals` (optional) A YAML file with global metadata values that can be used in the prompt template.
261+
- `--fake` (optional) Generates a fake response data (mostly for testing)
262262

263263
### Examples
264264

@@ -286,7 +286,7 @@ Prints all prompts to standard output.
286286

287287
### Arguments
288288

289-
`--where` (optional) A SQL WHERE clause to filter the results. Running `promplab prompts` will show the columns available for filtering. These are currently `['prompt_id', 'block_id', 'prompt', 'response', 'model', 'prompt_tag', 'created_at']`
289+
- `--where` (optional) A SQL WHERE clause to filter the results. Running `promplab prompts` will show the columns available for filtering. These are currently `['prompt_id', 'block_id', 'prompt', 'response', 'model', 'prompt_tag', 'created_at']`
290290

291291
### Examples
292292

@@ -308,9 +308,9 @@ Convert prompts into blocks or metadata. This is useful is you want to do later
308308

309309
### Arguments
310310

311-
`--where` (optional) A SQL WHERE clause to filter the results. Running `promplab transfer-prompts` will show the columns available for filtering. These are currently `['prompt_id', 'block_id', 'prompt', 'response', 'model', 'prompt_tag', 'created_at']`
312-
`--to` (required) The type of object to transfer the prompts to. Options are `blocks` or `metadata`.
313-
`--metadata_key` (optional) The key to use for the metadata. Only valid when `--to=metadata`.
311+
- `--where` (optional) A SQL WHERE clause to filter the results. Running `promplab transfer-prompts` will show the columns available for filtering. These are currently `['prompt_id', 'block_id', 'prompt', 'response', 'model', 'prompt_tag', 'created_at']`
312+
- `--to` (required) The type of object to transfer the prompts to. Options are `blocks` or `metadata`.
313+
- `--metadata_key` (optional) The key to use for the metadata. Only valid when `--to=metadata`.
314314

315315
### Examples
316316

0 commit comments

Comments
 (0)