bounty-eligible: Improve repeatable CLI agent workflow docs - #60
Open
hehee9 wants to merge 1 commit into
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdfiles, and attach MCP tools safely.It also updates the CLI command reference so readers use
swarms chatfor conversational sessions andswarms agent --taskfor scriptable one-shot jobs.Changes
Run repeatable CLI agentssection to/cli/tutorial.WORKSPACE_DIRand an absoluteAGENT_STATE_DIRshell variable.--saved-state-pathcreates a JSON state snapshot for review and debugging.MEMORY.mdfiles under$WORKSPACE_DIR/agents/<agent-name>/./cli/commandsto direct conversational usage toswarms chat.swarms agentconversational example.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 --checknpx mint broken-linkswas attempted, but the command stops on an existing syntax error inapi/group-chat.mdxat line 253 before link checking reaches the changed files.