https://github.com/danielroe/goff
Sync GitHub issues offline into a local folder
https://github.com/danielroe/goff
Last synced: about 1 year ago
JSON representation
Sync GitHub issues offline into a local folder
- Host: GitHub
- URL: https://github.com/danielroe/goff
- Owner: danielroe
- License: mit
- Created: 2024-04-20T07:22:06.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-03-31T09:34:05.000Z (about 1 year ago)
- Last Synced: 2025-04-02T09:08:37.746Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 777 KB
- Stars: 75
- Watchers: 1
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# goff
[![npm version][npm-version-src]][npm-version-href]
[![npm downloads][npm-downloads-src]][npm-downloads-href]
[![Github Actions][github-actions-src]][github-actions-href]
[![Codecov][codecov-src]][codecov-href]
> Sync GitHub issues offline into a local folder
🚧 This CLI is heavily in development - and contribution is welcome! But do expect changes in the public API...
## Usage
Run the sync command within the root of a Git repo. It will create a `.goff` folder and populate it with Markdown files corresponding to the GitHub issues in your repository.
```sh
npx goff@latest sync
# npx goff@latest sync --closed --repo unjs/fontaine
```
If you are hitting a GitHub rate limit you can create a token [here](https://github.com/settings/tokens/new) and provide it:
```sh
npx goff@latest auth --token
```
## 💻 Development
- Clone this repository
- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`
- Install dependencies using `pnpm install`
- Run interactive tests using `pnpm dev`
## License
Made with ❤️
Published under [MIT License](./LICENCE).
[npm-version-src]: https://img.shields.io/npm/v/goff?style=flat-square
[npm-version-href]: https://npmjs.com/package/goff
[npm-downloads-src]: https://img.shields.io/npm/dm/goff?style=flat-square
[npm-downloads-href]: https://npm.chart.dev/goff
[github-actions-src]: https://img.shields.io/github/actions/workflow/status/danielroe/goff/ci.yml?branch=main&style=flat-square
[github-actions-href]: https://github.com/danielroe/goff/actions?query=workflow%3Aci
[codecov-src]: https://img.shields.io/codecov/c/gh/danielroe/goff/main?style=flat-square
[codecov-href]: https://codecov.io/gh/danielroe/goff