Home / Node.js / Command-line utilities

Check if it's the first time the process is run

first-run Check if it's the first time the process is run Can be used to greet the user the first time they use your CLI app, show usage tip, initialize something, etc. Install $ npm install --save first-run
Information
Category: Node.js / Command-line utilities
Watchers: 7
Star: 80
Fork: 6
Last update: May 10, 2022
Resource links
https://github.com/sindresorhus/first-run

first-run Build Status

Check if it's the first time the process is run

Can be used to greet the user the first time they use your CLI app, show usage tip, initialize something, etc.

Install

$ npm install first-run

Usage

// x.js
const firstRun = require('first-run');

console.log(firstRun());
$ node x.js
true
$ node x.js
false

API

firstRun([options])

firstRun.clear([options])

Clear the state.

options

Type: Object

name

Type: string
Default: name field in your package.json

The name used to identify it.

License

MIT © Sindre Sorhus

1 Open More issues
Closed

Add clear option

Hey @sindresorhus I create a PR to integrate the clear param option to first-run. I've already add a test, test3.js, and the option in the README.md

Let me know if this is OK.

opened Aug 21, 2015 by vrunoa 12
Closed

Detect the first run for different versions

Start using versions, fixes #1.

If only name is set, works like it did before. Config record is backward compatible with previous versions. Essentially, it will work out of the box with versioning without changes of code for most users.

Currently, full versions are compared, but if we want to have partial comparison, I need proposals on flexibility we want.

opened May 10, 2019 by stroncium 9
Closed

Detect first run of different versions

This fixes #1 (except the reset case, since that was already dealt with).

opened Dec 2, 2016 by pteixeira 3
Closed

Add clear option

Hey @sindresorhus , I start using first-run, first of all, really useful module. :+1: For testing purposes I have to clear the first run value several times, searching in your code I see you use this code to clear it;

(new Configstore('first-run_first-run')).clear();

But in different projects, I would have to change the name, 'first-run_first-run', 'first-run_other-project',... so I add a clear option to firstRun, and clear your project first-run like

firstRun({clear:true})

Here's the source; https://github.com/Urucas/first-run/blob/master/index.js#L20 Let me know if you think this functionality is OK for a PR.

enhancement help wanted 
opened Aug 18, 2015 by vrunoa 3
Closed

Move to GitHub Actions

null

opened Jan 1, 2021 by Richienb 0
Closed

Require Node.js 8, add TypeScript definition

opened Apr 14, 2019 by BendingBender 0
Open

[feature request] reset config, detect first run of different version

Issuehunt badges

Hi, do you think it would be a good idea to implement methods to reset the config or some detection that would check if the module was ran first time on a different version?

There is a $40.00 open bounty on this issue. Add more on Issuehunt.

enhancement help wanted :dollar: Funded on Issuehunt 
opened Aug 6, 2015 by petersandor 3

v3.0.0(Oct 14, 2021)

Breaking

  • Require Node.js 12.20 5da56d9
  • This package is now pure ESM. Please read this.
  • The name option is now required as it's no longer possible to infer it.

https://github.com/sindresorhus/first-run/compare/v2.0.0...v3.0.0

v2.0.0(Apr 15, 2019)

Breaking:

  • Require Node.js 8 (#5) a401044

Enhancements:

  • Add TypeScript definition (#5) a401044

https://github.com/sindresorhus/first-run/compare/v1.2.0...v2.0.0

Contents

    felixweyne Process Spawn Control is a Powershell tool which aims to help in the behavioral (process) analysis of malware. PsC suspends newly launched processes, and gives the analyst the option to either keep the process suspended, or to resume it.
    dcposch Run WebTorrent in one process, control it from another process or even another machine
    kagurazakasanae A lib that allows using mhyprot2 driver for enum process modules, r/w process memory and kill process.
    radovskyb process is a simple Go package for working with unix processes.
    radovskyb gobeat is a process health check monitor, command automation tool and process restarter.
    sindresorhus Check if a process is running
    joshtriplett Rust crate to use process file descriptors (pidfd) for Linux
    mafintosh A "top" like module for your Node.js process. Collects CPU usage etc.
    jlevy Lightweight command-line process control
    Redth .NET MAUI Check tool
    sindresorhus Check if the process is running with elevated privileges
    basecamp Rails engine for cache-friendly, client-side local time
    oasis-engine Oasis Engine is a web-first and mobile-first high-performance real-time development platform.
    taylorconor A quine that plays snake over its own source!
    mafintosh Run cleanup logic just before the process exits without interfering
    nakabonne Real-time visualization tool for Go process metrics
    vzhou842 A fast, robust Python library to check for offensive language in strings.
    lijinke666 :art: a image process component for react
    0xyg3n Inject your x64 bit executable to any process, masking it as a legitimate process for Anti-Virus evasion.
    hasherezade Process Ghosting - a PE injection technique, similar to Process Doppelgänging, but using a delete-pending file instead of a transacted file
    YarikSOffice A lightweight tool that simplifies testing of the process death scenario.
    Share this repo

    Related Repos


    Command-line utiliti
    1.9k
    A reliable, user-friendly Plain Text Accounting tool with command line, terminal and web i...
    simonmichael hledger project README lightweight, portable, dependable accounting tools hledger is a computer program for easily tracking money, time, or other comm
     
    Command-line utiliti
    1k
    Simple argument parsing
    vercel Simple argument parsing
     
    Command-line utiliti
    45
    CLI tool for Arco Design
    arco-design A command-line interface tool for creating, developing and managing Arco materials.
     
    Command-line utiliti
    147
    💦 Turn your full-stack NodeJS application into a downloadable cross-platform binary. Also...
    crisdosyago 💦 Turn your full-stack NodeJS application into a downloadable cross-platform binary. Also works for SPAs, or regular web-sites.
     
    Command-line utiliti
    583
    The smallest and fastest command-line coloring package on the internet.
    sindresorhus The smallest and fastest command-line coloring package on the internet.
     
    Command-line utiliti
    26
    Express-api-cli is a command line tool that generates an express project structure preconf...
    tolustar Express-api-cli is a command line tool that generates an express project structure preconfigured with most commonly used packages that can spped up your development workflow.
     
    Command-line utiliti
    12
    Curated links for the Loot Project
    jpgboi 🔗 Links Twitter OpenSea Discord Etherscan Website 📚 Resources Rarity and attributes spreadsheet by @AustinGreen 0xinventory.app is a loot bag and it
     
    Command-line utiliti
    198
    Git multiple user config manager
    gauseen Git multiple user config manager
     
    Command-line utiliti
    22
    ⚡️ Set up Next.js Progressive Web App with `npx create-next-pwa`
    msaaddev A cross-platform Node.js based CLI tool that creates Progressive Web App (PWA) with Next.js. You can also integrate tailwind with the Next.js PWA using this CLI with a single command.
     
    Command-line utiliti
    31.1k
    A tool for writing better scripts
    google Bash is great, but when it comes to writing scripts, people usually choose a more convenient programming language. JavaScript is a perfect choice, but standard Node.js library requires additional hassle before using. zx package provides useful wrappers around child_process, escapes arguments and gives sensible defaults.
     
    Command-line utiliti
    13
    ☕️ Build tests with Webpack and run with Mocha in one command
    privatenumber Build tests with Webpack and run them with Mocha in one command
     
    Command-line utiliti
    17.8k
    Fig adds VSCode style autocomplete to your terminal
    withfig Fig adds autocomplete to the terminal. As you type, Fig pops up subcommands, options, and contextually relevant arguments in your existing terminal on macOS.
     
    Command-line utiliti
    29
    Detect whether the terminal supports Unicode
    sindresorhus Detect whether the terminal supports Unicode
     
    Command-line utiliti
    3.9k
    CLI and build-time tool to find & fix known vulnerabilities in open-source dependencies
    snyk CLI and build-time tool to find & fix known vulnerabilities in open-source dependencies
     
    Command-line utiliti
    120
    A CLI tool to make a single executable AppImage from any website
    sarweshparajuli Appnativefy is an NPM package to make executable AppImage files from any website, it uses the Nativefier API in the backend, with AppImageKIt.