docs(readme): revise readme with expanded cli and manifest docs#7
Merged
Conversation
rework README content to clarify CLI usage, expand command examples, and update the manifest format. summarize key changes: - replace warning block with callout style - reorganize quick start to show init, add/install flows and re-install behavior - clarify `agentfiles install` semantics: first `install <source>` scans and saves the source as a dependency; `agentfiles install` with no args re-installs saved deps - document new flags: `--pick`, `--no-save`, `--dry-run` and clarify `--strategy` applies per-dependency - add `agentfiles list` and `agentfiles remove` command docs (with `--clean`) - update manifest docs: `files` -> `dependencies`, add simple string and detailed dependency forms (`source`, `ref`, `pick`, `strategy`, `paths`) - update examples throughout to match the new manifest and CLI behavior these are documentation-only changes; no code or tests modified.
add a paths filter to pull_request so the workflow only triggers when the CI workflow, Cargo manifest/lock, or source files change ( .github/workflows/ci.yml, Cargo.toml, Cargo.lock, src/**). reduce unnecessary CI runs for unrelated changes.
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
1 participant
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.
rework README content to clarify CLI usage, expand command examples, and update the manifest format. summarize key changes:
agentfiles installsemantics: firstinstall <source>scans and saves the source as a dependency;agentfiles installwith no args re-installs saved deps--pick,--no-save,--dry-runand clarify--strategyapplies per-dependencyagentfiles listandagentfiles removecommand docs (with--clean)files->dependencies, add simple string and detailed dependency forms (source,ref,pick,strategy,paths)these are documentation-only changes; no code or tests modified.