Usage
What it does
The config command saves the path to your PM-Auto configuration file in ~/.pm-auto/settings.json. This path is used by all other PM-Auto commands to read your preset definitions.
When you run this command, PM-Auto will:
- Create the
~/.pm-auto directory if it doesn’t exist
- Resolve the provided path to an absolute path
- Save the path to
~/.pm-auto/settings.json
- Prepend an example preset to your config file (if not already present)
You must run pm-auto config <path> after creating or moving your config file. All other commands will fail without a valid config path.
Examples
Set config with relative path
pm-auto config ./pm-auto.json
┌ pm-auto
│
◇ Config file path saved: ./pm-auto.json
◇ Prepending example to file: /Users/username/projects/myapp/pm-auto.json
◇ Example prepended successfully
Set config with absolute path
pm-auto config /Users/username/projects/myapp/pm-auto.json
┌ pm-auto
│
◇ Config file path saved: /Users/username/projects/myapp/pm-auto.json
◇ Prepending example to file: /Users/username/projects/myapp/pm-auto.json
◇ Example prepended successfully
Set config in home directory
pm-auto config ~/pm-auto.json
┌ pm-auto
│
◇ Config file path saved: ~/pm-auto.json
◇ Prepending example to file: /Users/username/pm-auto.json
◇ Example prepended successfully
Example preset
When you run pm-auto config, an example preset is automatically added to your config file:
{
"example": {
"presetName": "example",
"description": "A sample configuration demonstrating all options for PM-Auto",
"packageManager": "bun",
"packages": [
{
"command": "create-next-app",
"interactive": true,
"dev": false,
"version": "latest",
"flags": ["."]
},
{
"command": "shadcn",
"interactive": true,
"dev": false,
"version": "latest",
"flags": ["init"]
},
{
"command": "gsap",
"interactive": false,
"dev": false,
"version": "3.11.4",
"flags": ["--peer-deps"]
},
{
"command": "@react-three/fiber",
"interactive": false,
"dev": false
},
{
"command": "clsx",
"interactive": false,
"dev": false
},
{
"command": "@types/three",
"interactive": false,
"dev": true
}
]
}
}
Where the config is stored
Your config path is stored in:
The file looks like this:
{
"configPath": "/Users/username/projects/myapp/pm-auto.json"
}
Updating the config path
If you move your config file or want to use a different config file, simply run the command again:
pm-auto config ./new-location/pm-auto.json
The config path is resolved to an absolute path using Node.js fs.realpathSync(), so relative paths will be converted to absolute paths.
Error handling
If the file doesn’t exist at the provided path:
pm-auto config ./non-existent.json
┌ pm-auto
│
✖ Error saving config file: ENOENT: no such file or directory
touch pm-auto.json
pm-auto config ./pm-auto.json