# glitch-deploy

> CLI tool to deploy a GitHub repository to glitch.com

Latest version **1.1.6** (published 2018-10-10) · Apache-2.0 license · 0 weekly downloads

## Install

```sh
npm install glitch-deploy
pnpm add glitch-deploy
yarn add glitch-deploy
bun add glitch-deploy
```

Provides the command `glitch-deploy`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.6 |
| Published | 2018-10-10 |
| First published | 2017-08-27 |
| Weekly downloads | 0 |
| License | Apache-2.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 608.2 KB |
| Known vulnerabilities | 0 (+25 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 63 |
| Author | Gregor Martynus |
| Maintainers | glitch-tools-bot, gr2m |
| Keywords | glitch, cli, deploy |

## Links

- npm: https://www.npmjs.com/package/glitch-deploy
- Repository: https://github.com/glitch-tools/glitch-deploy
- Homepage: https://github.com/glitch-tools/glitch-deploy#readme
- Issues: https://github.com/glitch-tools/glitch-deploy/issues
- npm.io page: https://npm.io/package/glitch-deploy

## Dependencies (9)

- [axios](https://npm.io/package/axios.md) ^0.18.0
- [debug](https://npm.io/package/debug.md) ^3.1.0
- [keytar](https://npm.io/package/keytar.md) ^4.0.4
- [lodash](https://npm.io/package/lodash.md) ^4.17.5
- [envalid](https://npm.io/package/envalid.md) ^4.1.4
- [inquirer](https://npm.io/package/inquirer.md) ^5.1.0
- [puppeteer](https://npm.io/package/puppeteer.md) ^0.13.0
- [github-url-from-git](https://npm.io/package/github-url-from-git.md) ^1.5.0
- [github-username-regex](https://npm.io/package/github-username-regex.md) ^1.0.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 1.1.6 (latest) — 2018-10-10
- 1.1.5 — 2018-10-10
- 1.1.4 — 2018-09-26
- 1.1.3 — 2018-03-20
- 1.1.2 — 2018-03-20
- 1.1.1 — 2017-08-28
- 1.1.0 — 2017-08-27
- 1.0.0 — 2017-08-27

## README

# glitch-deploy

> CLI tool to deploy a GitHub repository to glitch.com

![Glitch Deploy Screencast](/assets/glitch-deploy-screencast.gif?raw=true)

## Usage

```
# requires node 8
npx glitch-deploy
```

Enable debug logs

```
DEBUG=glitch-deploy* npx glitch-deploy
```

Show browser UI

```
SHOW_BROWSER=1 npx glitch-deploy
```

## Deploy from CI

`glitch-deploy` can be run as part of your continious integration, for example
using [Travis CI](https://travis-ci.org/).

You have to set the following environment variables

- `GITHUB_USERNAME`
- `GITHUB_PASSWORD`
- `GITHUB_REPO` _(e.g. `octocat/Hello-World`)_
- `GLITCH_DOMAIN` _(the name of your Glitch app)_

It’s recommended to create a separate GitHub user account for the deployment to
keep your own account’s credentials safe. If the given Glitch app already exists
then make sure the account is invited as collaborator. If the repository is
private you have to invite the account as collaborator on GitHub, too.

Happy auto-deploying to Glitch :)

## How it works

`glitch-deploy` is using [puppeteer](https://github.com/GoogleChrome/puppeteer)
to run a headless Chrome browser to sign in to GitHub & Glitch, create a new
Glitch app and import the repository form GitHub.

Note that `glitch-deploy` is using undocumented Glitch APIs that might change at
any time.

## License

[Apache 2.0](LICENSE)

---
_Source: https://npm.io/package/glitch-deploy · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._