https://github.com/threepointone/wangler
Evil wrangler.
https://github.com/threepointone/wangler
Last synced: 29 days ago
JSON representation
Evil wrangler.
- Host: GitHub
- URL: https://github.com/threepointone/wangler
- Owner: threepointone
- License: mit
- Created: 2024-12-18T21:30:02.000Z (5 months ago)
- Default Branch: main
- Last Pushed: 2025-01-11T19:34:04.000Z (4 months ago)
- Last Synced: 2025-04-08T17:52:09.314Z (about 1 month ago)
- Language: TypeScript
- Size: 81.1 KB
- Stars: 14
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# wangler
_Evil wrangler. A place for experiments by Sunil. Use at your own caution._
A wrapper around `wrangler`. For the lolz.
As of now, this adds just one feature: it automatically loads environment variables from `.env` files and populates `process.env` in your Cloudflare Workers.
## Why
This is a feature that wrangler will eventually ship, but I wanted it now for my own stuff.
## Installation
```bash
npm install wangler wrangler
```
## Usage
1. Create a `.env` file in your project root:
```env
API_KEY=your-api-key
DATABASE_URL=your-database-url
```
2. Use the `wangler` command instead of `wrangler`:
```bash
npx wangler dev # or wangler deploy
```
3. Reference `process.env`/`import.meta.env` in your code:
```js
console.log(process.env.API_KEY); // your-api-key
console.log(import.meta.env.DATABASE_URL); // your-database-url
```
## Additional features:
- These values are also injected into a request handler's `env` object.
- You can pass a path to a custom `.env` file via `--env-file `.
- You can also have environment specific `.env` files. For example, you can have a `.env.dev` file for development and a `.env.prod` file for production. To use, pass `--env ` where `` is the name of the environment you want to use. (This works with wrangler's own `--env` flag, where it'll pick bindings and values defined under `[env.]` in `wrangler.toml`)
- You can pass values in the cli via `--penv :`. This is useful for passing in arguments defined in your actual environment (like in CI, you can do `npx wangler dev --penv DATABASE_URL:$SUPABASE_URL` to pass in a value for `DATABASE_URL`).
- You can pass values in the cli via `--penv ` to have the value be read from the environment. This is useful for passing in arguments defined in your actual environment (like in CI, you can do `npx wangler dev --penv DATABASE_URL` to have the value for process.env.DATABASE_URL be read from the environment).
### `"ReferenceError: process is not defined"` thrown if env variable does not exist:
- See [this issue](https://github.com/threepointone/wangler/issues/2). tl;dr - add `compatibility_flags = ["nodejs_compat"]` to your `wrangler.toml` for a better error message.
## How it works
This tool wraps the standard Wrangler CLI and automatically converts your `.env` file variables into `--define` arguments that Wrangler understands. It's a drop-in replacement for Wrangler that adds `.env` file support.
## License
MIT