https://github.com/juwit/aspirator
a simple zx script that clones Github repositories
https://github.com/juwit/aspirator
Last synced: 12 months ago
JSON representation
a simple zx script that clones Github repositories
- Host: GitHub
- URL: https://github.com/juwit/aspirator
- Owner: juwit
- Created: 2021-10-22T08:08:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2021-10-22T08:09:01.000Z (over 4 years ago)
- Last Synced: 2025-06-02T07:38:57.764Z (about 1 year ago)
- Language: JavaScript
- Size: 2.93 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# aspirator
a script that clones github repositories
## pre-requisites
* a NodeJS environment
* a personal access token for your github account, with the `repo` scope (can be created at https://github.com/settings/tokens)
## usage
### with zx
* install zx : `npm i -g zx`
* install dependencies: `npm i`
* run the script : `zx ./aspirator.mjs` or `./aspirator.mjs`
### with npx
* install dependencies: `npm i`
* run the script : `npx zx ./aspirator.mjs`
## configuration
aspirator can also be configured with environment variables:
| env var | description |
|------------------|---------------------------------------------------|
| GITHUB_TOKEN | a Github personal access token, with `repo` scope |
| REPO_NAME_FILTER | a regex pattern to filter repository names |