Markdown-based GitHub Repository Serializer

Node.js tool to serialize entire GitHub repositories into a markdown string.

Installation

npm install -g github-repo-serializer

Usage

Command Line

The following command...

github-repo-serializer --r https://github.com/octocat/Hello-World.git

...produces the following output:

To write the output in a text file, use the "output" optional argument:

github-repo-serializer --r https://github.com/octocat/Hello-World.git --o myserializedrepo.txt

To serialize the current directory tree, omit the "repo" optional argument:

github-repo-serializer --o myserializedcd.txt

Programmatically

const serializeGitHubRepo = require('github-repo-serializer');

serializeGitHubRepo('https://github.com/octocat/Hello-World.git')
  .then(output => console.log(output))
  .catch(error => console.error('Error:', error));

Development

Running Tests

To run the tests:

npm test

Continuous Integration

This project uses GitHub Actions for continuous integration. Tests are automatically run on push and pull requests to the main branch.

License

MIT license