FM / commands

/usr/local/lib/node_modules/npm/docs/content/commands/

/usr/local/lib/node_modules/npm/docs/content/commands

Name	Size	Mode	Actions
npm-access.md	2888	0644	edit dl rm
npm-adduser.md	2033	0644	edit dl rm
npm-audit.md	16252	0644	edit dl rm
npm-bugs.md	2997	0644	edit dl rm
npm-cache.md	3450	0644	edit dl rm
npm-ci.md	9770	0644	edit dl rm
npm-completion.md	908	0644	edit dl rm
npm-config.md	4091	0644	edit dl rm
npm-dedupe.md	9543	0644	edit dl rm
npm-deprecate.md	2156	0644	edit dl rm
npm-diff.md	8985	0644	edit dl rm
npm-dist-tag.md	5170	0644	edit dl rm
npm-docs.md	2975	0644	edit dl rm
npm-doctor.md	5047	0644	edit dl rm
npm-edit.md	1091	0644	edit dl rm
npm-exec.md	11357	0644	edit dl rm
npm-explain.md	2794	0644	edit dl rm
npm-explore.md	1006	0644	edit dl rm
npm-find-dupes.md	6791	0644	edit dl rm
npm-fund.md	3674	0644	edit dl rm
npm-get.md	445	0644	edit dl rm
npm-help-search.md	755	0644	edit dl rm
npm-help.md	1003	0644	edit dl rm
npm-init.md	10213	0644	edit dl rm
npm-install-ci-test.md	8083	0644	edit dl rm
npm-install-test.md	11573	0644	edit dl rm
npm-install.md	29306	0644	edit dl rm
npm-link.md	12386	0644	edit dl rm
npm-ll.md	5686	0644	edit dl rm
npm-login.md	2354	0644	edit dl rm
npm-logout.md	1749	0644	edit dl rm
npm-ls.md	7148	0644	edit dl rm
npm-org.md	1974	0644	edit dl rm
npm-outdated.md	6978	0644	edit dl rm
npm-owner.md	3082	0644	edit dl rm
npm-pack.md	3832	0644	edit dl rm
npm-ping.md	769	0644	edit dl rm
npm-pkg.md	8056	0644	edit dl rm
npm-prefix.md	1206	0644	edit dl rm
npm-profile.md	3067	0644	edit dl rm
npm-prune.md	5737	0644	edit dl rm
npm-publish.md	8028	0644	edit dl rm
npm-query.md	6954	0644	edit dl rm
npm-rebuild.md	4994	0644	edit dl rm
npm-repo.md	2755	0644	edit dl rm
npm-restart.md	1444	0644	edit dl rm
npm-root.md	1096	0644	edit dl rm
npm-run.md	7538	0644	edit dl rm
npm-sbom.md	8338	0644	edit dl rm
npm-search.md	3560	0644	edit dl rm
npm-set.md	1433	0644	edit dl rm
npm-shrinkwrap.md	909	0644	edit dl rm
npm-star.md	1712	0644	edit dl rm
npm-stars.md	743	0644	edit dl rm
npm-start.md	1632	0644	edit dl rm
npm-stop.md	1320	0644	edit dl rm
npm-team.md	4084	0644	edit dl rm
npm-test.md	1213	0644	edit dl rm
npm-token.md	4905	0644	edit dl rm
npm-trust.md	10073	0644	edit dl rm
npm-undeprecate.md	1406	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	12972	0644	edit dl rm
npm-version.md	8011	0644	edit dl rm
npm-view.md	7425	0644	edit dl rm
npm-whoami.md	800	0644	edit dl rm
npm.md	5638	0644	edit dl rm
npx.md	6287	0644	edit dl rm

Edit: /usr/local/lib/node_modules/npm/docs/content/commands/npm-start.md (1632B)

---
title: npm-start
section: 1
description: Start a package
---

### Synopsis

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

### Description

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

If the `"scripts"` object does not define a  `"start"` property, npm will run `node server.js`.

Note that this is different from the default node behavior of running the file specified in a package's `"main"` attribute when evoking with `node .`

As of [`npm@2.0.0`](https://blog.npmjs.org/post/98131109725/npm-2-0-0), you can use custom arguments when executing scripts.
Refer to [`npm run`](/commands/npm-run) for more details.

### Example

```json
{
  "scripts": {
    "start": "node foo.js"
  }
}
```

```bash
npm start

> npm@x.x.x start
> node foo.js

(foo.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` 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](/commands/npm-run)
* [npm scripts](/using-npm/scripts)
* [npm test](/commands/npm-test)
* [npm restart](/commands/npm-restart)
* [npm stop](/commands/npm-stop)

cmd: