chore: improve doc
This commit is contained in:
parent
ac1fb953fc
commit
63c5e2cf7b
@ -73,24 +73,17 @@ For a complete example of how to use this module, see the [Goose module](https:/
|
|||||||
|
|
||||||
### Start script behavior
|
### Start script behavior
|
||||||
|
|
||||||
The `start_script` should write the agent command to `$module_path/agent-command.sh` instead of starting the AgentAPI server directly. The module will start the server using:
|
The `start_script` should write the agent command to `$module_path/agent-command.sh` instead of starting the AgentAPI server directly.
|
||||||
|
|
||||||
```bash
|
|
||||||
agentapi server --type ./agent-command.sh < type > --term-width < width > --term-height < height > --
|
|
||||||
```
|
|
||||||
|
|
||||||
Example start script:
|
Example start script:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
# Hardcode your module's path
|
|
||||||
module_path="$HOME/.my-module"
|
module_path="$HOME/.my-module"
|
||||||
|
|
||||||
cat > "$module_path/agent-command.sh" << 'EOF'
|
cat > "$module_path/agent-command.sh" << EOF
|
||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
my-agent-command --my-agent-flags
|
my-agent-command --my-agent-flags
|
||||||
# OR
|
|
||||||
boundary my-agent-command --my-agent-flags
|
|
||||||
EOF
|
EOF
|
||||||
|
|
||||||
chmod +x "$module_path/agent-command.sh"
|
chmod +x "$module_path/agent-command.sh"
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user