README.md updated explain PICOCLAW_CONFIG and PICOCLAW_HOME
This commit is contained in:
parent
0f8cd0dc2e
commit
f2fe1414d6
2 changed files with 25 additions and 1 deletions
25
README.md
25
README.md
|
|
@ -623,6 +623,31 @@ Connect Picoclaw to the Agent Social Network simply by sending a single message
|
||||||
|
|
||||||
Config file: `~/.picoclaw/config.json`
|
Config file: `~/.picoclaw/config.json`
|
||||||
|
|
||||||
|
### Environment Variables
|
||||||
|
|
||||||
|
You can override default paths using environment variables. This is useful for portable installations, containerized deployments, or running picoclaw as a system service. These variables are independent and control different paths.
|
||||||
|
|
||||||
|
| Variable | Description | Default Path |
|
||||||
|
|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------|---------------------------|
|
||||||
|
| `PICOCLAW_CONFIG` | Overrides the path to the configuration file. This directly tells picoclaw which `config.json` to load, ignoring all other locations. | `~/.picoclaw/config.json` |
|
||||||
|
| `PICOCLAW_HOME` | Overrides the root directory for picoclaw data. This changes the default location of the `workspace` and other data directories. | `~/.picoclaw` |
|
||||||
|
|
||||||
|
**Examples:**
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Run picoclaw using a specific config file
|
||||||
|
# The workspace path will be read from within that config file
|
||||||
|
PICOCLAW_CONFIG=/etc/picoclaw/production.json picoclaw gateway
|
||||||
|
|
||||||
|
# Run picoclaw with all its data stored in /opt/picoclaw
|
||||||
|
# Config will be loaded from the default ~/.picoclaw/config.json
|
||||||
|
# Workspace will be created at /opt/picoclaw/workspace
|
||||||
|
PICOCLAW_HOME=/opt/picoclaw picoclaw agent
|
||||||
|
|
||||||
|
# Use both for a fully customized setup
|
||||||
|
PICOCLAW_HOME=/srv/picoclaw PICOCLAW_CONFIG=/srv/picoclaw/main.json picoclaw gateway
|
||||||
|
```
|
||||||
|
|
||||||
### Workspace Layout
|
### Workspace Layout
|
||||||
|
|
||||||
PicoClaw stores data in your configured workspace (default: `~/.picoclaw/workspace`):
|
PicoClaw stores data in your configured workspace (default: `~/.picoclaw/workspace`):
|
||||||
|
|
|
||||||
|
|
@ -27,7 +27,6 @@ func DefaultConfig() *Config {
|
||||||
Agents: AgentsConfig{
|
Agents: AgentsConfig{
|
||||||
Defaults: AgentDefaults{
|
Defaults: AgentDefaults{
|
||||||
Workspace: workspacePath,
|
Workspace: workspacePath,
|
||||||
|
|
||||||
RestrictToWorkspace: true,
|
RestrictToWorkspace: true,
|
||||||
Provider: "",
|
Provider: "",
|
||||||
Model: "",
|
Model: "",
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue