npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ngenv

v2.0.5

Published

Writes ngrok tunnel url to .env file

Downloads

4

Readme

Ngenv

Ngenv is a Node.js CLI tool that enhances development workflows by seamlessly integrating ngrok tunnels. It simplifies the process of starting an ngrok tunnel and automatically updates your project's .env file with the newly generated ngrok URL, ensuring your environment variables are always synchronized with ngrok's dynamic URLs. This tool is invaluable for developers working with webhooks, APIs, and external services that require secure, reliable tunneling to localhost.

Features

  • Automation: Starts an ngrok tunnel and updates the .env file without manual intervention.
  • Flexibility: Supports running ngrok in both foreground for direct interaction and background for uninterrupted terminal use.
  • Customization: Allows for custom ngrok configurations, including protocol, port, and .env file path specifications.
  • Log Management: Provides utility commands for managing ngrok process logs in background mode.

Prerequisites

  • Node.js (Version 10 or newer)
  • An ngrok account and authtoken, obtainable by signing up at ngrok.com.

Installation

  1. Global Installation:

    Install Ngenv globally with npm:

    npm install -g ngenv
  2. Configure ngrok:

    Set up your ngrok with your authtoken:

    ngrok authtoken <your-ngrok-authtoken>

Usage

Running ngrok in the Foreground

The run command initiates the ngrok tunnel in the foreground, maintaining it active in the current terminal session for immediate feedback.

ngenv run

Starting the ngrok Tunnel in the Background

The start command launches the ngrok tunnel as a background task, ensuring only one instance runs at a time, freeing up the terminal.

ngenv start

In background mode, ngenv handles log files for output and errors, aiding in debugging and monitoring.

Stopping the ngrok Tunnel

Terminate a background ngrok tunnel with the stop command:

ngenv stop

Viewing Logs

Inspect output and error logs (only applicable in background mode):

ngenv logs

Clearing Logs

Remove log files associated with background processes:

ngenv clear

Command Options (start and run)

  • -P, --proto <protocol>: Specify the protocol (default: http).
  • -p, --port <port>: Set the port for ngrok to forward (default: 3000).
  • -e, --env <path>: Define a custom path to your .env file.

Examples

Foreground operation on port 8080:

ngenv run --port 8080

Background operation with HTTPS protocol:

ngenv start --proto https

Custom .env file path in background mode:

ngenv start --env /path/to/your/.env

Troubleshooting

  • Ensure ngrok is properly installed and your authtoken is configured.
  • Check permissions for updating .env files and managing processes.
  • In background mode, consult log files for potential issues.

Contributing

We welcome contributions! Feel free to open issues or submit pull requests with your ideas, bug fixes, or features.

License

Ngenv is available under the MIT License. See the LICENSE file for more details.


For more information on ngrok, please visit ngrok's official documentation.