together 2.10.0

A tool to merge text/code files in a folder

Together

A simple command-line tool to concatenate text and code files, respecting .gitignore rules.

Why?

I often need to provide a complete project context to AI models. This tool simplifies the process of bundling all relevant files into a single text file, making it easy to upload or paste.

Example: Manual Exclusion

You can manually specify every file or folder to ignore. This is powerful but can be verbose.

tog \
    '/path/to/project/**' \
    --output=ai.txt \
    --ignore-folders=vendor \
    --ignore-folders=test_files \
    --ignore-folders=bin \
    --ignore-extensions=lock,bash \
    --ignore-files=LICENSE.md \
    --ignore-wild='*react*' \
    --ignore-wild='*test*'

Example: Using a .gitignore file (Recommended)

For a much cleaner command, you can add the same rules to a .gitignore file and use the --gitignore flag.

First, your .gitignore file would look like this:

# .gitignore
vendor/
test_files/
bin/
*.lock
*.bash
LICENSE.md

Then, the command becomes simple and reusable:

tog '/path/to/project/**' --output=ai.txt --gitignore

Example: Using Wildcard Patterns

You can use wildcard patterns to ignore files or folders that match specific patterns anywhere in their path:

# Ignore any file or folder containing 'react' in the name
tog '/path/to/project/**' --output=ai.txt --ignore-wild='*react*'

# Ignore multiple patterns
tog '/path/to/project/**' --output=ai.txt --ignore-wild='*test*' --ignore-wild='*spec*' --ignore-wild='*node_modules*'

# Combine with other ignore options
tog '/path/to/project/**' --output=ai.txt --ignore-wild='*react*' --ignore-extensions=log,tmp

# Common use cases with --ignore-wild
# Ignore all Node.js related files and folders
tog '/path/to/project/**' --output=ai.txt --ignore-wild='*node_modules*' --ignore-wild='*package-lock*'

# Ignore all test-related files
tog '/path/to/project/**' --output=ai.txt --ignore-wild='*test*' --ignore-wild='*spec*' --ignore-wild='*__tests__*'

# Ignore build artifacts and cache files
tog '/path/to/project/**' --output=ai.txt --ignore-wild='*build*' --ignore-wild='*dist*' --ignore-wild='*cache*' --ignore-wild='*.tmp*'

# Ignore framework-specific files (React, Vue, Angular)
tog '/path/to/project/**' --output=ai.txt --ignore-wild='*react*' --ignore-wild='*vue*' --ignore-wild='*angular*'

Example: Self-Update

Keep your tog binary up to date with the latest version from GitHub:

# Check for updates and install the latest version
tog --self-update

The self-update feature will:

• Check the latest release on GitHub
• Download the appropriate binary for your operating system (Linux, macOS, or Windows)
• Create a backup of the current version
• Replace the current binary atomically
• Clean up temporary files

Personal usage on this project

Since I do this a lot of times, I use a makefile on every project. The command below uses the project's own .gitignore to exclude development files.

⚡ make
dart ./main.dart . --output=ai.txt --gitignore
Skipping file ./.DS_Store due to encoding issues.
Adding file ./main.dart
Adding file ./README.md
Adding file ./pubspec.yaml
Adding file ./tests.dart

Output file: ai.txt

Usage

1. Download the binary for your OS from the releases page.
2. Make it executable: chmod +x /path/to/downloaded/tog
3. (Optional) Move it to a directory in your PATH: mv /path/to/downloaded/tog /usr/local/bin/
4. Run it from your terminal: tog '<path1>' '<path2>' ... [options]

Important Note on Glob Patterns: Always wrap glob patterns (paths containing * or **) in single quotes (e.g., 'src/**/*.dart'). This prevents your shell (like Bash or ZSH) from expanding the pattern itself, ensuring that tog receives it correctly and can search recursively as intended.

<path>                 Specifies paths to process. Use single quotes for glob patterns (e.g., 'src/**') to ensure correct expansion.
--output               Specifies the output file name
                       (defaults to "output.txt")
--ignore-extensions    Specifies file extensions to ignore (comma separated)
--ignore-folders       Specifies folders to globally ignore (can be used multiple times)
--ignore-files         Specifies files to globally ignore (can be used multiple times)
--ignore-wild          Specifies wildcard patterns to ignore files/folders (can be used multiple times, e.g., *react*)
--gitignore            Ignores files and directories based on the .gitignore file
                       in the current directory.
-h, --help             Show this help message.
--self-update          Download and install the latest version from GitHub.

Glob Pattern Examples

The ** pattern is powerful. It matches directories recursively. Using it correctly is key to leveraging tog.

• 'src/*.dart': Match all Dart files directly inside the src directory.
• 'lib/docs/file.txt': Process a single, specific file (quotes are optional but good practice).
• 'assets/**': The key pattern. Match everything inside assets, including files in assets itself and in all subdirectories, recursively. This is the most common way to process an entire folder.
• '**/*.dart': Match all files ending with .dart in the current directory and all subdirectories.
• 'api/app/Http/Controllers/**': Match all files and folders inside Controllers, recursively.
• 'api/app/Http/Controllers/**/*.php': Match only files ending with .php inside Controllers and its subdirectories.

Using Dart

Run

dart run main.dart 'path/to/folder/**' 'specific/file.txt'

Compile

make will compile the binary for your OS to ~/bin/tog.

tog 'path/to/any/folder/**' 'specific/file.txt'