Rstring: Rsync-Powered Code Stringification
Rstring is a developer tool that uses Rsync to efficiently gather and stringify code from your projects. It's designed to streamline the process of preparing code context for AI programming assistants, making it easy to get intelligent insights about your codebase.
Quickly prompt an LLM with your whole project!
Installation
Rstring requires Python 3.8+. We recommend using pipx for installation, as it installs Rstring in an isolated environment, preventing conflicts with other packages.
Using pipx (recommended)
-
Install pipx if you haven't already. Follow the official pipx installation guide for your operating system.
-
Install Rstring:
pipx install rstring
Using pip
If you prefer to use pip, you can install Rstring with:
pip install rstring
Updating Rstring
To update Rstring to the latest version:
With pipx:
pipx upgrade rstring
With pip:
pip install --upgrade rstring
For more detailed information about pipx and its usage, refer to the pipx documentation.
Quick Start
Basic usage:
rstring # All files (filtered by .gitignore)
Work with different directories:
rstring /path/to/project # Analyze a specific directory
rstring -C /path/to/project # Change directory before processing
Custom filtering:
rstring --include='*.py' # Only Python files
rstring --include='*/' --include='*.js' --exclude='test*' # Complex patterns
Get help:
rstring --help
Get a tree view of selected files:
rstring --summary
Advanced Usage
Custom Filtering
Rstring uses rsync's powerful include/exclude patterns:
# Include only Python files
rstring --include='*/' --include='*.py' --exclude='*'
# Include web development files, exclude tests
rstring --include='*/' --include='*.{js,css,html}' --exclude='test*' --exclude='*'
# Include documentation
rstring --include='*/' --include='*.md' --include='*.rst' --exclude='*'
Creating Custom Shortcuts
For frequently used patterns, create shell aliases in your .bashrc or .zshrc:
# Python source files only
alias rstring-py="rstring --include='*/' --include='*.py' --exclude='test*'"
# Web development files
alias rstring-web="rstring --include='*/' --include='*.{js,ts,css,html}' --exclude='node_modules/'"
# Documentation files
alias rstring-docs="rstring --include='*/' --include='*.{md,rst,txt}' --exclude='*'"
# All source code (no tests, docs, or config)
alias rstring-src="rstring --include='src/' --include='lib/' --exclude='*'"
Usage:
rstring-py # Python files in current directory
rstring-web -C /path/to/app # Web files in different directory
rstring-docs --summary # Documentation with tree view
File Preview
Limit output to first N lines of each file:
rstring --preview-length=10
Gitignore Integration
By default, Rstring automatically excludes .gitignore patterns. To ignore .gitignore:
rstring --no-gitignore
Interactive mode
Enter interactive mode to continuously preview and select matched files:
rstring -i
Understanding Rstring
-
Under the Hood: Rstring efficiently selects files based on filters by running
rsync --archive --itemize-changes --dry-run --list-only <your filters>. This means you can use Rsync's powerful include/exclude patterns to customize file selection. -
Default Behavior: When run without specific patterns, rstring includes all files and directories, filtered by your project's
.gitignorefile. -
Output Format:
--- path/to/file1.py --- [File contents] --- path/to/file2.js --- [File contents] -
Binary Files: Content of binary files is represented as a hexdump preview.
-
Clipboard Integration: Output is automatically copied to clipboard unless disabled with
--no-clipboard. -
Git Integration: By default, Rstring respects .gitignore patterns. Use
--no-gitignoreto ignore them.
Pro Tips
-
Start simple:
rstringwith no arguments gives you everything in your project (filtered by .gitignore). -
Refer to Rsync documentation: Rstring uses Rsync for file selection. Refer to the Filter Rules section of the rsync man page to understand how include/exclude patterns work.
-
Create project-specific aliases: Set up shell aliases for your common file selection patterns.
-
Use with AI tools: Rstring is great for preparing code context for AI programming assistants.
-
Large projects may produce substantial output: Use
--preview-lengthor specific patterns for better manageability.
Common Patterns
Here are some useful rsync patterns for different scenarios:
# Python projects
rstring --include='*/' --include='*.py' --exclude='__pycache__/' --exclude='test*'
# JavaScript/Node.js projects
rstring --include='*/' --include='*.{js,ts,jsx,tsx}' --exclude='node_modules/' --exclude='test*'
# Web projects (frontend)
rstring --include='*/' --include='*.{js,ts,css,html,vue,svelte}' --exclude='dist/' --exclude='build/'
# Documentation only
rstring --include='*/' --include='*.{md,rst,txt}' --exclude='*'
# Configuration files
rstring --include='*/' --include='*.{json,yaml,yml,toml,ini}' --exclude='*'
# Source code only (exclude tests, docs, config)
rstring --include='src/' --include='lib/' --exclude='*'
Support and Contributing
- Issues and feature requests: GitHub Issues
- Contributing: See CONTRIBUTING.md for development setup and guidelines
- Pull requests welcome!
License
Rstring is released under the MIT License. See the LICENSE file for details.
Metadata
Release files for rstring 0.4.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| rstring-0.4.1.tar.gz | 15.0 kB | With provenance | Details for rstring-0.4.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| rstring-0.4.1-py3-none-any.whl | Python 3 | none | any | Details for rstring-0.4.1-py3-none-any.whl |
Total release size: 29.4 kB
Release files / rstring-0.4.1.tar.gz
| Download URL | rstring-0.4.1.tar.gz |
|---|---|
| Size | 15.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
85374a302f86c23bfe2b4304131ed62139fd6594b96a795c847e155d72dbe467
|
|
BLAKE2b-256 checksum How to use checksums |
2de66d238d4b4344ea5751cbe0b4e93d32ef01f4365aaf7499af8c6e5bfeb3a7
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 13, 2025.
Transparency logRelease files / rstring-0.4.1-py3-none-any.whl
| Download URL | rstring-0.4.1-py3-none-any.whl |
|---|---|
| Size | 14.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
7b78139fde30561329e374546d5422e1b8fe4c8fd3ed5766e9709cb49477fbb2
|
|
BLAKE2b-256 checksum How to use checksums |
2e17d810185683a9721f0c1f589560f6523a1073fa0a8741d937c41ae9c274fc
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/6.1.0 CPython/3.12.9
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 13, 2025.
Transparency logSecurity for rstring 0.4.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for rstring-0.4.1.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Jun 13, 2025.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.