https://github.com/sinclairzx81/drift
Run Chrome from the Terminal
https://github.com/sinclairzx81/drift
Last synced: about 1 year ago
JSON representation
Run Chrome from the Terminal
- Host: GitHub
- URL: https://github.com/sinclairzx81/drift
- Owner: sinclairzx81
- License: other
- Created: 2022-08-24T10:20:49.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2024-08-09T06:04:04.000Z (almost 2 years ago)
- Last Synced: 2025-04-09T18:10:01.611Z (about 1 year ago)
- Language: TypeScript
- Size: 12.2 MB
- Stars: 16
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: license
Awesome Lists containing this project
README
Drift
Run Chrome from the Terminal
[](https://badge.fury.io/js/%40sinclair%2Fdrift)
[](https://github.com/sinclairzx81/drift/actions)
## Install
```bash
$ npm install -g @sinclair/drift
```
## Usage
```bash
$ drift url http://localhost:5000
```
## Overview
Drift is a command line tool that integrates the Chrome Developer Console into the terminal. It is built upon the Chrome DevTools Protocol and implements an interactive repl for running code in remote Chrome instances. Drift enables browser functionality to be developed and tested entirely from within a terminal window.
Drift works similar to Node but runs code in constrained browser environments. It can be used for browser automation, running browser code in CI environments or used as a general purpose scripting tool.
License MIT
## Contents
- [Install](#Install)
- [Commands](#Commands)
- [Examples](#Examples)
- [Testing](#Testing)
- [Contribute](#Contribute)
## Commands
The Drift CLI accepts a series of commands which are run in sequence against a sandboxed Chrome instance. When all commands have completed, Drift will enter an interactive repl similar to the Chrome DevTools Console.
The following is the Drift command line interface
```
Format:
$ drift [...command]
Examples:
$ drift url https://domain.com
$ drift run script.ts
$ drift url https://domain.com run script.ts
$ drift url https://domain.com wait 1000 save image.png
$ drift window devtools url https://domain.com
Commands:
url url Load page
run path Add script to page
css path Add style to page
save path Save page as image or pdf
args [...args] Adds args to Drift.args
watch [...path] Watch and reload
user path User directory
mousedown x y Send mousedown event
position x y Desktop window position
size w h Desktop window size
wait ms Wait timeout
reload Reload page
close Close drift
Flags:
window Open window
devtools Open devtools
incognto Open incognito
verbose Log Chrome messages
reset Reset user directory
fail Close drift on exceptions
help Show this help message
```
## Examples
The following are some examples
```bash
# starts with interactive repl
$ drift
```
```bash
# opens github.com
$ drift url http://github.com
```
```bash
# runs index.ts
$ drift run index.ts
```
```bash
# opens a window, runs index.ts, waits 5 seconds then closes
$ drift window run index.ts wait 5000 close
```
```bash
# opens github.com, waits 4 seconds then takes a screenshot
$ drift url https://github.com wait 4000 save screenshot.png
```
## Testing
When testing browser code in CI environments, call `close(...)` to terminate the process with a non zero exit code on error. CI environments will interpret this is a failed process.
```typescript
test().then(() => close(0)).catch(() => close(1))
```
Which can be run on CI environments with the following.
```bash
$ drift run test.ts
```
## Contribute
Drift is open to community contribution. Please ensure you submit an open issue before submitting a pull request. The Drift project preferences open community discussion prior to accepting new features.