FM / commands

/snap/node/11782/lib/node_modules/npm/docs/content/commands/

/snap/node/11782/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	3664	0644	edit dl rm
npm-adduser.md	1847	0644	edit dl rm
npm-audit.md	15656	0644	edit dl rm
npm-bugs.md	2996	0644	edit dl rm
npm-cache.md	2962	0644	edit dl rm
npm-ci.md	9125	0644	edit dl rm
npm-completion.md	909	0644	edit dl rm
npm-config.md	4093	0644	edit dl rm
npm-dedupe.md	8895	0644	edit dl rm
npm-deprecate.md	1741	0644	edit dl rm
npm-diff.md	9109	0644	edit dl rm
npm-dist-tag.md	5181	0644	edit dl rm
npm-docs.md	2974	0644	edit dl rm
npm-doctor.md	5057	0644	edit dl rm
npm-edit.md	1091	0644	edit dl rm
npm-exec.md	11401	0644	edit dl rm
npm-explain.md	2795	0644	edit dl rm
npm-explore.md	1006	0644	edit dl rm
npm-find-dupes.md	6797	0644	edit dl rm
npm-fund.md	3673	0644	edit dl rm
npm-help-search.md	756	0644	edit dl rm
npm-help.md	1004	0644	edit dl rm
npm-hook.md	2394	0644	edit dl rm
npm-init.md	9855	0644	edit dl rm
npm-install-ci-test.md	7434	0644	edit dl rm
npm-install-test.md	9814	0644	edit dl rm
npm-install.md	24984	0644	edit dl rm
npm-link.md	11742	0644	edit dl rm
npm-login.md	2171	0644	edit dl rm
npm-logout.md	1749	0644	edit dl rm
npm-ls.md	8547	0644	edit dl rm
npm-org.md	1975	0644	edit dl rm
npm-outdated.md	5779	0644	edit dl rm
npm-owner.md	3093	0644	edit dl rm
npm-pack.md	3448	0644	edit dl rm
npm-ping.md	769	0644	edit dl rm
npm-pkg.md	8129	0644	edit dl rm
npm-prefix.md	1211	0644	edit dl rm
npm-profile.md	3102	0644	edit dl rm
npm-prune.md	5745	0644	edit dl rm
npm-publish.md	7622	0644	edit dl rm
npm-query.md	6958	0644	edit dl rm
npm-rebuild.md	5001	0644	edit dl rm
npm-repo.md	2754	0644	edit dl rm
npm-restart.md	1473	0644	edit dl rm
npm-root.md	1097	0644	edit dl rm
npm-run-script.md	7561	0644	edit dl rm
npm-sbom.md	8337	0644	edit dl rm
npm-search.md	3464	0644	edit dl rm
npm-shrinkwrap.md	923	0644	edit dl rm
npm-star.md	1713	0644	edit dl rm
npm-stars.md	743	0644	edit dl rm
npm-start.md	1667	0644	edit dl rm
npm-stop.md	1341	0644	edit dl rm
npm-team.md	4090	0644	edit dl rm
npm-test.md	1234	0644	edit dl rm
npm-token.md	2893	0644	edit dl rm
npm-uninstall.md	4447	0644	edit dl rm
npm-unpublish.md	4491	0644	edit dl rm
npm-unstar.md	1574	0644	edit dl rm
npm-update.md	11871	0644	edit dl rm
npm-version.md	6902	0644	edit dl rm
npm-view.md	5612	0644	edit dl rm
npm-whoami.md	800	0644	edit dl rm
npm.md	5670	0644	edit dl rm
npx.md	5895	0644	edit dl rm

Edit: /snap/node/11782/lib/node_modules/npm/docs/content/commands/npm-test.md (1234B)

---
title: npm-test
section: 1
description: Test a package
---

### Synopsis

```bash
npm test [-- <args>]

aliases: tst, t
```

### Description

This runs a predefined command specified in the `"test"` property of
a package's `"scripts"` object.

### Example

```json
{
  "scripts": {
    "test": "node test.js"
  }
}
```

```bash
npm test
> npm@x.x.x test
> node test.js

(test.js output would be here)
```

### Configuration

#### `ignore-scripts`

* Default: false
* Type: Boolean

If true, npm does not run scripts specified in package.json files.

Note that commands explicitly intended to run a particular script, such as
`npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script`
will still run their intended script if `ignore-scripts` is set, but they
will *not* run any pre- or post-scripts.

#### `script-shell`

* Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows
* Type: null or String

The shell to use for scripts run with the `npm exec`, `npm run` and `npm
init <package-spec>` commands.

### See Also

* [npm run-script](/commands/npm-run-script)
* [npm scripts](/using-npm/scripts)
* [npm start](/commands/npm-start)
* [npm restart](/commands/npm-restart)
* [npm stop](/commands/npm-stop)

--- title: npm-test section: 1 description: Test a package --- ### Synopsis ```bash npm test [-- ] aliases: tst, t ``` ### Description This runs a predefined command specified in the `"test"` property of a package's `"scripts"` object. ### Example ```json { "scripts": { "test": "node test.js" } } ``` ```bash npm test > npm@x.x.x test > node test.js (test.js output would be here) ``` ### Configuration #### `ignore-scripts` * Default: false * Type: Boolean If true, npm does not run scripts specified in package.json files. Note that commands explicitly intended to run a particular script, such as `npm start`, `npm stop`, `npm restart`, `npm test`, and `npm run-script` will still run their intended script if `ignore-scripts` is set, but they will *not* run any pre- or post-scripts. #### `script-shell` * Default: '/bin/sh' on POSIX systems, 'cmd.exe' on Windows * Type: null or String The shell to use for scripts run with the `npm exec`, `npm run` and `npm init ` commands. ### See Also * [npm run-script](/commands/npm-run-script) * [npm scripts](/using-npm/scripts) * [npm start](/commands/npm-start) * [npm restart](/commands/npm-restart) * [npm stop](/commands/npm-stop)