Sheafy is a command-line tool that bundles project files into a single Markdown document and can restore files from such bundles. It's particularly useful for sharing code with AI assistants or archiving projects in a readable format.
- Smart Bundling: Collects files from your project directory into a well-formatted Markdown file.
- Flexible Ignoring: Uses
.gitignorerules by default and supports additional custom ignore patterns viasheafy.toml. - Restore Capability: Can recreate the original file structure from a bundle.
- Configurable: Supports prologue/epilogue text, output filename, working directory, and ignore behavior configuration.
- Ensure you have Rust installed (via rustup)
- Clone this repository
- Build and install:
cargo install --path .
Create a bundle (using defaults and .gitignore):
sheafy bundleCreate a bundle with a specific output name:
sheafy bundle -o my_project_bundle.mdRestore files from a bundle:
sheafy restore project_bundle.mdInitialize a default sheafy.toml config file:
sheafy initCreate a sheafy.toml file in your project root to customize behavior:
[sheafy]
# Output filename for bundle command, optional, default `project_bundle.md`
# bundle_name = "docs/project_bundle.md"
# Optional working directory (relative to where sheafy is run), optional, default "."
# working_dir = "src"
# Whether to respect .gitignore rules, optional, default true
# use_gitignore = true
# Optional: Add custom ignore patterns (multi-line string, gitignore syntax)
# These are applied *in addition* to .gitignore rules (if use_gitignore is true).
# Patterns are relative to the working directory.
# ignore_patterns = """
# # Ignore all log files
# *.log
#
# # Ignore specific directories
# target/
# node_modules/
#
# # But include specific file types within an ignored directory (if needed)
# # !target/*.rs
# """
# Optional prologue text to include at start of bundle
# prologue = """
# # Project Bundle
#
# This is a bundle of all files in the project directory.
# """
# Optional epilogue text to include at end of bundle
# epilogue = """
# # """USAGE:
sheafy init
Creates a default sheafy.toml file.
USAGE:
sheafy bundle [OPTIONS]
OPTIONS:
-o, --output <OUTPUT> Output Markdown filename (overrides config)
--use-gitignore Force use of .gitignore rules (overrides config if set to false)
--no-gitignore Force disabling .gitignore rules (overrides config and --use-gitignore)
Note: File inclusion/exclusion is now primarily controlled by .gitignore (if enabled) and the ignore_patterns setting in sheafy.toml.
USAGE:
sheafy restore [INPUT_FILE]
ARGS:
<INPUT_FILE> The Markdown file to restore from (optional, defaults to `bundle_name` in config or `project_bundle.md`)
Bundle using default settings:
# Creates project_bundle.md respecting .gitignore and sheafy.toml ignore_patterns
sheafy bundleBundle ignoring .gitignore rules but using sheafy.toml patterns:
sheafy bundle --no-gitignoreBundle to a specific file:
sheafy bundle -o my_code.mdRestore files overwriting existing ones:
sheafy restore backup_bundle.mdSee for more information.