# Is gh-pages ESM-only? Can you require() it?

> gh-pages@6.3.0 is a CommonJS package. CommonJS — require() works on every Node.js version we test.

Publish to a gh-pages branch on GitHub (or any other branch on any other remote)

Last verified Sep 9, 2026 against gh-pages@6.3.0.

gh-pages ships CommonJS only. require("gh-pages") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=10. import "gh-pages" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.

## What to do

1. require("gh-pages") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=10.
2. From ES modules use the default import: import ghPages from "gh-pages"; then destructure. Named imports only work when Node.js can statically detect the exports.
3. TypeScript: npm install -D @types/gh-pages

## Facts

- Latest: 6.3.0 (Jan 2, 2025)
- Module format: CommonJS
- Last CommonJS version: 6.3.0
- TypeScript types: @types/gh-pages
- Node engines: >=10
- Weekly downloads: 569K
- License: MIT

## Runtime test results for gh-pages@6.3.0

Installed and executed on Sep 9, 2026 with require("gh-pages") from a CommonJS file and import "gh-pages" from an ES module.

| Runtime | require("gh-pages") | import "gh-pages" |
|---|---|---|
| Node.js 18 | works | works |
| Node.js 20 | works | works |
| Node.js 22 | works | works |
| Node.js 24 | works | works |
| Node.js 26 | works | works |
| Bun 1.4.0 | works | works |

## How to import gh-pages

ES modules:

```js
import ghPages from "gh-pages";
```

CommonJS:

```js
const ghPages = require("gh-pages");
```

## Module format by version

Derived from the type, main and exports fields of every stable release on npm (34 versions; the newest 34 shown).

| Versions | Format | First published |
|---|---|---|
| 0.1.0 – 6.3.0 | CommonJS | Mar 18, 2014 |

## Frequently asked

**Is gh-pages ESM-only?**

gh-pages@6.3.0 is a CommonJS package. gh-pages ships CommonJS only. require("gh-pages") works on every Node.js version we test (18, 20, 22, 24 and 26) and in Bun. The package declares Node.js >=10. import "gh-pages" also works because Node.js and Bun can import CommonJS from ES modules, but only the default export is guaranteed; named imports depend on Node's static analysis of the module.

**Can I import gh-pages with ES module syntax?**

Yes. import ghPages from "gh-pages" works in Node.js and Bun because they support importing CommonJS modules. Named imports work only when Node.js can statically detect the exports.

**Does gh-pages work in Bun?**

Yes. import "gh-pages" loaded successfully in Bun 1.4.0 on Sep 9, 2026.

**Does gh-pages ship TypeScript types?**

Not bundled. Install the community types with "npm install -D @types/gh-pages".

## Links

- [gh-pages on npm](https://www.npmjs.com/package/gh-pages)
- [Source repository](https://github.com/tschaub/gh-pages)
- [HTML version](https://canirequire.com/package/gh-pages/)
- [JSON version](https://canirequire.com/package/gh-pages.json)

---

For scripts and AI agents: any package is at https://canirequire.com/package/<name>/index.md (Markdown) or https://canirequire.com/package/<name>.json (JSON); the site index is https://canirequire.com/llms.txt. Fetch the URL directly; no search needed.