dspy-profiles¶
A CLI for managing DSPy profiles.
Usage¶
dspy-profiles [OPTIONS] COMMAND [ARGS]...
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
-v, --version |
Show the version and exit. | No | - |
--help |
Show this message and exit. | No | - |
Commands¶
| Name | Description |
|---|---|
list |
Lists all available profiles and their... |
show |
Shows the full configuration details of a... |
delete |
Deletes a specified profile. |
set |
Sets or updates a configuration value for... |
init |
Initializes a new profile interactively. |
import |
Imports a profile from a .env file. |
diff |
Compares two profiles and highlights their... |
validate |
Validates the structure and content of the... |
test |
Tests connectivity to the language model... |
run |
Executes a command with the specified... |
Sub Commands¶
dspy-profiles list¶
Lists all available profiles and their core details.
Usage¶
dspy-profiles list [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--json |
Output the list of profiles in JSON format. | No | - |
--help |
Show this message and exit. | No | - |
dspy-profiles show¶
Shows the full configuration details of a specific profile.
Usage¶
dspy-profiles show [OPTIONS] PROFILE_NAME
Arguments¶
| Name | Description | Required |
|---|---|---|
PROFILE_NAME |
The name of the profile to display. | Yes |
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--json |
Output the profile in JSON format. | No | - |
--help |
Show this message and exit. | No | - |
dspy-profiles delete¶
Deletes a specified profile.
Usage¶
dspy-profiles delete [OPTIONS] PROFILE_NAME
Arguments¶
| Name | Description | Required |
|---|---|---|
PROFILE_NAME |
The name of the profile to delete. | Yes |
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
-f, --force |
Delete the profile without prompting for confirmation. | No | - |
--help |
Show this message and exit. | No | - |
dspy-profiles set¶
Sets or updates a configuration value for a given profile.
Usage¶
dspy-profiles set [OPTIONS] PROFILE_NAME KEY VALUE
Arguments¶
| Name | Description | Required |
|---|---|---|
PROFILE_NAME |
The name of the profile to modify. | Yes |
KEY |
The configuration key to set (e.g., 'lm.model'). | Yes |
VALUE |
The value to set for the key. | Yes |
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--help |
Show this message and exit. | No | - |
dspy-profiles init¶
Initializes a new profile interactively.
Usage¶
dspy-profiles init [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
-p, --profile TEXT |
The name for the new profile. [default: (default)] | No | - |
-f, --force |
Overwrite the profile if it already exists. | No | - |
--help |
Show this message and exit. | No | - |
dspy-profiles import¶
Imports a profile from a .env file.
Usage¶
dspy-profiles import [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
-p, --profile TEXT |
The name for the new profile. | Yes | - |
--from FILE |
The path to the .env file to import from. [default: .env] | No | - |
--help |
Show this message and exit. | No | - |
dspy-profiles diff¶
Compares two profiles and highlights their differences.
Usage¶
dspy-profiles diff [OPTIONS] PROFILE_A_NAME PROFILE_B_NAME
Arguments¶
| Name | Description | Required |
|---|---|---|
PROFILE_A_NAME |
The first profile to compare. | Yes |
PROFILE_B_NAME |
The second profile to compare. | Yes |
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--help |
Show this message and exit. | No | - |
dspy-profiles validate¶
Validates the structure and content of the profiles.toml file.
Usage¶
dspy-profiles validate [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
-c, --config FILE |
Path to the profiles.toml file. [default: /home/runner/.dspy/profiles.toml] | No | - |
--help |
Show this message and exit. | No | - |
dspy-profiles test¶
Tests connectivity to the language model for a given profile.
Usage¶
dspy-profiles test [OPTIONS] PROFILE_NAME
Arguments¶
| Name | Description | Required |
|---|---|---|
PROFILE_NAME |
The name of the profile to test. | Yes |
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
--help |
Show this message and exit. | No | - |
dspy-profiles run¶
Executes a command with the specified profile's environment variables.
Usage¶
dspy-profiles run [OPTIONS]
Arguments¶
No arguments available
Options¶
| Name | Description | Required | Default |
|---|---|---|---|
-p, --profile TEXT |
The profile to activate for the command. | Yes | - |
--help |
Show this message and exit. | No | - |