Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/darcyclarke/rawkit

🦊 Immediately Open Chrome DevTools when debugging Node.js apps
https://github.com/darcyclarke/rawkit

browser chrome cli debugger devtool devtools inspector nodejs rawkit tools

Last synced: about 8 hours ago
JSON representation

🦊 Immediately Open Chrome DevTools when debugging Node.js apps

Host: GitHub
URL: https://github.com/darcyclarke/rawkit
Owner: darcyclarke
License: mit
Created: 2017-05-19T17:42:01.000Z (over 7 years ago)
Default Branch: master
Last Pushed: 2022-02-07T12:13:17.000Z (almost 3 years ago)
Last Synced: 2025-01-05T06:12:40.623Z (7 days ago)
Topics: browser, chrome, cli, debugger, devtool, devtools, inspector, nodejs, rawkit, tools
Language: JavaScript
Homepage:
Size: 1.49 MB
Stars: 324
Watchers: 7
Forks: 20
Open Issues: 16
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

awesome-github-star - rawkit

README

[![npm version](https://badge.fury.io/js/rawkit.svg)](https://badge.fury.io/js/rawkit)
[![Build Status](https://travis-ci.org/darcyclarke/rawkit.svg?branch=master)](https://travis-ci.org/darcyclarke/rawkit)
[![Build status](https://ci.appveyor.com/api/projects/status/aypcyq2ry7jh8a1k?svg=true)](https://ci.appveyor.com/project/darcyclarke/rawkit)
[![Known Vulnerabilities](https://snyk.io/test/github/darcyclarke/rawkit/badge.svg)](https://snyk.io/test/github/darcyclarke/rawkit)
[![Dependency Status](https://david-dm.org/darcyclarke/rawkit/master.svg)](https://david-dm.org/darcyclarke/rawkit/master)

# rawkit

**rawkit** grabs the chrome inspector URL returned from the `node --inspect` command and immediately opens devtools. No more *clicking*, *selecting*, *copying*/*pasting* or *navigating*. Just run the command and jump into debugging.

## Installation & Usage

```bash
$ npm install -g rawkit
...
$ rawkit example.js
```

#### With [npx](https://www.npmjs.com/package/npx)
```bash
$ npx rawkit example.js
```

tutorial

## Features

- ✅ Works offline
- ✅ Supports `nodemon` & reloading
- ✅ Supports legacy Node ` **Note:** `--executable` is an experimental feature as rawkit typically does all the work to determine the right executable to use based on your operating system and any other arguments or environmental configuration.

## FAQ

### Chrome opens to a blank page?
You may have some issues if your version of Chrome has recently updated and it and/or your OS hasn't be restarted. Quick fix here is to just try restarting Chrome and/or restarting your machine. This was identified in the [`opn`](https://github.com/sindresorhus/opn/issues/83) project.

### Do I need to install a Chrome Extension?

**rawkit** will automatically launch a splash page asking you to install a corresponding Chrome Extension the first time you run it. If you don't want to install the extension (not recommended, as the extension comes with some nice-to-have behaviors) AND are using a Mac, you can install [chrome-cli](https://github.com/prasmussen/chrome-cli) to get around this. **rawkit** will automatically detect if `chrome-cli` exists on your machine and use that to open/launch chrome once it's installed.

```bash
$ brew install chrome-cli
```

> **Note:** Unfortunately, opening internal Chrome links, externally, is not possible without an aid at the moment (ie. urls that contain `chrome://` or `chrome-devtools://` in this case). This is most likely a security feature. That said, you can use a Chrome Extension as a proxy to make this work. Check out the [RESEARCH.md](https://github.com/darcyclarke/rawkit/blob/master/RESEARCH.md) for more information.