Skip to content

Commit f90bde2

Browse files
authored
Merge pull request #509 from smallstep/carl/fix-troubleshooting-agent
Fix macOS and Linux commands
2 parents 05def56 + 03f8e68 commit f90bde2

1 file changed

Lines changed: 11 additions & 11 deletions

File tree

platform/troubleshooting-agent.mdx

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The Smallstep Agent includes a `doctor` command that performs automated health c
139139

140140
**On macOS:**
141141
```bash
142-
step-agent-plugin doctor
142+
/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent doctor
143143
```
144144

145145
**On Windows:**
@@ -149,7 +149,7 @@ step-agent-plugin doctor
149149

150150
**On Linux:**
151151
```bash
152-
sudo step-agent-plugin doctor
152+
sudo step-agent doctor
153153
```
154154

155155
The doctor command runs a series of checks and displays results in a table format:
@@ -332,7 +332,7 @@ Each check validates a specific aspect of the agent's functionality. A **PASS**
332332
To test certificate renewal as part of the doctor checks, use the `--renew` flag:
333333

334334
```bash
335-
step-agent-plugin doctor --renew
335+
step-agent doctor --renew
336336
```
337337

338338
This will attempt to renew all endpoint certificates and report any failures. This is useful when:
@@ -349,7 +349,7 @@ The `--renew` flag will trigger certificate renewal for all endpoints, which may
349349
For scripting or integration with monitoring tools, use the `--json` flag:
350350

351351
```bash
352-
step-agent-plugin doctor --json
352+
step-agent doctor --json
353353
```
354354

355355
This outputs check results in JSON format:
@@ -402,7 +402,7 @@ This outputs check results in JSON format:
402402

403403
**Solutions:**
404404
1. Check system requirements are met
405-
2. Run `step-agent-plugin doctor` to identify specific issues
405+
2. Run `step-agent doctor` to identify specific issues
406406
3. Check agent logs for startup errors
407407
4. Restart the system if the TPM is in an inconsistent state
408408
5. On Linux, check for conflicting services using the same ports
@@ -430,7 +430,7 @@ This outputs check results in JSON format:
430430

431431
**Solutions:**
432432
1. Check system clock is accurate
433-
2. Run `step-agent-plugin doctor --renew` to force renewal
433+
2. Run `step-agent doctor --renew` to force renewal
434434
3. If agent was offline for extended period, certificates may have expired
435435
4. Check agent logs for renewal errors
436436
5. Verify connectivity to your team's CA
@@ -499,7 +499,7 @@ If you've tried the troubleshooting steps above and still have issues:
499499
- **macOS/Windows:** Export logs from the desktop app
500500
3. **Note your configuration:**
501501
- Operating system and version
502-
- Smallstep Agent version (`step-agent-plugin version`)
502+
- Smallstep Agent version (`step-agent version`)
503503
- Any error messages or failure descriptions
504504
4. **Contact Smallstep support** with the information above
505505

@@ -518,7 +518,7 @@ Quick reference for platform-specific commands and file locations.
518518
| Check if agent is running | Activity Monitor → search for `SmallstepAgent` |
519519
| Check agent version | `/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent version` |
520520
| Restart agent | `launchctl stop com.smallstep.launchd.SmallstepAgent` |
521-
| Run doctor | `step-agent-plugin doctor` |
521+
| Run doctor | `/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent doctor` |
522522
| Certificate location | `/Users/<user>/Library/Application Support/Smallstep/certificates/` |
523523
| Inspect a certificate | `step certificate inspect --bundle /path/to/cert.crt` |
524524
| Collect logs | `/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent logs collect /tmp/smallstep.log` |
@@ -538,12 +538,12 @@ Quick reference for platform-specific commands and file locations.
538538
| Task | Command or Location |
539539
|------|---------------------|
540540
| Check if agent is running | `systemctl status step-agent` |
541-
| Check agent version | `step-agent-plugin version` |
541+
| Check agent version | `step-agent version` |
542542
| Restart agent | `sudo systemctl restart step-agent` |
543-
| Run doctor | `sudo step-agent-plugin doctor` |
543+
| Run doctor | `sudo step-agent doctor` |
544544
| Certificate location | `/var/lib/step-agent/certificates/` |
545545
| Agent logs | `/var/lib/step-agent/logs/` or `sudo journalctl -u step-agent` |
546-
| Collect logs | `step-agent-plugin logs collect --log-dir /var/lib/step-agent/logs` |
546+
| Collect logs | `step-agent logs collect --log-dir /var/lib/step-agent/logs` |
547547
| Agent configuration | `/etc/step-agent/agent.yaml` |
548548

549549
<Alert severity="info">

0 commit comments

Comments
 (0)