Skip to content

bounty-eligible: Improve repeatable CLI agent workflow docs - #60

Open
hehee9 wants to merge 1 commit into
The-Swarm-Corporation:mainfrom
hehee9:docs/repeatable-cli-agents-bounty
Open

bounty-eligible: Improve repeatable CLI agent workflow docs#60
hehee9 wants to merge 1 commit into
The-Swarm-Corporation:mainfrom
hehee9:docs/repeatable-cli-agents-bounty

Conversation

@hehee9

@hehee9 hehee9 commented Jun 19, 2026

Copy link
Copy Markdown

Summary

This PR improves the Swarms CLI docs for repeatable agent runs. It adds a new 500+ word section to the CLI tutorial that explains how to set up a workspace, keep state snapshots separate, inspect persistent MEMORY.md files, and attach MCP tools safely.

It also updates the CLI command reference so readers use swarms chat for conversational sessions and swarms agent --task for scriptable one-shot jobs.

Changes

  • Adds a new Run repeatable CLI agents section to /cli/tutorial.
  • Shows a repeatable project layout with WORKSPACE_DIR and an absolute AGENT_STATE_DIR shell variable.
  • Clarifies that --saved-state-path creates a JSON state snapshot for review and debugging.
  • Points CLI users to persistent MEMORY.md files under $WORKSPACE_DIR/agents/<agent-name>/.
  • Adds MCP safety guidance for trusted servers, read-only tools, credentials, and debugging.
  • Updates /cli/commands to direct conversational usage to swarms chat.
  • Removes the misleading no-task swarms agent conversational example.
  • Tightens several explanations after an editorial pass for clarity and concision.

Bounty eligibility

Please consider this PR bounty-eligible under the Swarms Documentation Bounty Program:

https://docs.swarms.world/community/bounty-program

Suggested tier: Gold.

Rationale: the PR adds a major CLI guide section over 500 words, improves command accuracy, and updates examples that affect repeatable agent workflows.

Testing

  • git diff --check
  • Checked Markdown code fence balance in the changed files.
  • Checked absolute internal links in the changed files.
  • Reviewed the updated docs for readability, link consistency, and CLI behavior accuracy.
  • npx mint broken-links was attempted, but the command stops on an existing syntax error in api/group-chat.mdx at line 253 before link checking reaches the changed files.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant