Skip to content
Policy management tool for Node.js
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
bin
examples
src
.editorconfig
.eslintrc
.gitignore
README.md
oclif.manifest.json
package-lock.json
package.json

README.md

node-policy

oclif Version CircleCI Codecov Downloads/week License

Usage

$ npm install -g @bradleymeck/node-policy
$ node-policy COMMAND
running command...
$ node-policy (-v|--version|version)
@bradleymeck/node-policy/0.0.0 darwin-x64 node-v11.7.0
$ node-policy --help [COMMAND]
USAGE
  $ node-policy COMMAND
...

Commands

node-policy extract DESTINATION

Create a new policy file that only contains paths pointing within a specific prefix

USAGE
  $ node-policy extract DESTINATION

ARGUMENTS
  DESTINATION  desired new path of the policy file

OPTIONS
  -p, --policy=policy  [default: /Users/bfarias/.node-policy.json] path of policy file being
  --prefix=prefix      (required) prefix that all resources path should be within, even relative ones

DESCRIPTION
  Create a new policy file that only contains paths pointing within a specific prefix

See code: src/commands/extract.js

node-policy help [COMMAND]

display help for node-policy

USAGE
  $ node-policy help [COMMAND]

ARGUMENTS
  COMMAND  command to show help for

OPTIONS
  --all  see all commands in CLI

See code: @oclif/plugin-help

node-policy install

////////

USAGE
  $ node-policy install

OPTIONS
  -p, --policy=policy                [default: /Users/bfarias/.node-policy.json] path of policy file being
  --fix=(always|never|prompt)        [default: prompt]
  --package-manager=package-manager  [default: npm]

DESCRIPTION
  ////////
  UNSTABLE
  ////////
  Installs the current directory without running install scripts
  then runs install scripts with integrity checks applied

See code: src/commands/install.js

node-policy integrity:add LOCATION

Adds integrity values for a location.

USAGE
  $ node-policy integrity:add LOCATION

ARGUMENTS
  LOCATION  desired location

OPTIONS
  -a, --algorithm=(sha256|sha384|sha512)  (required) digest algorithm to use for integrity checks
  -d, --discard                           discards other integrities for the resources
  -p, --policy=policy                     [default: /Users/bfarias/.node-policy.json] path of policy file being

DESCRIPTION
  Adds integrity values for a location.

See code: src/commands/integrity/add.js

node-policy integrity:delete LOCATION

Removes integrity values for a location.

USAGE
  $ node-policy integrity:delete LOCATION

ARGUMENTS
  LOCATION  desired location

OPTIONS
  -p, --policy=policy  [default: /Users/bfarias/.node-policy.json] path of policy file being

DESCRIPTION
  Removes integrity values for a location.

See code: src/commands/integrity/delete.js

node-policy integrity:verify LOCATION

Checks integrity values for a location.

USAGE
  $ node-policy integrity:verify LOCATION

ARGUMENTS
  LOCATION  desired location

OPTIONS
  -i, --interactive
  -p, --policy=policy  [default: /Users/bfarias/.node-policy.json] path of policy file being

DESCRIPTION
  Checks integrity values for a location.

See code: src/commands/integrity/verify.js

node-policy integrity:view LOCATION

Shows all integrity values for a location.

USAGE
  $ node-policy integrity:view LOCATION

ARGUMENTS
  LOCATION  desired location

OPTIONS
  -p, --policy=policy  [default: /Users/bfarias/.node-policy.json] path of policy file being

DESCRIPTION
  Shows all integrity values for a location.

See code: src/commands/integrity/view.js

node-policy locate

Prints the location of the policy file, complaining if some common misconfiguration

USAGE
  $ node-policy locate

OPTIONS
  -p, --policy=policy  [default: /Users/bfarias/.node-policy.json] path of policy file being
  --strict             exits with an error if policy is misconfigured

DESCRIPTION
  Prints the location of the policy file, complaining if some common misconfiguration

See code: src/commands/locate.js

node-policy mv DESTINATION

Move a policy file to a new location, rewriting resource paths as needed

USAGE
  $ node-policy mv DESTINATION

ARGUMENTS
  DESTINATION  desired new path of the policy file

OPTIONS
  -p, --policy=policy  [default: /Users/bfarias/.node-policy.json] path of policy file being

DESCRIPTION
  Move a policy file to a new location, rewriting resource paths as needed

See code: src/commands/mv.js

node-policy run

Prints the location of the policy file, complaining if some common misconfiguration

USAGE
  $ node-policy run

OPTIONS
  -i, --interactive    allow prompting for interactions regarding policies
  -p, --policy=policy  [default: /Users/bfarias/.node-policy.json] path of policy file being

DESCRIPTION
  Prints the location of the policy file, complaining if some common misconfiguration

See code: src/commands/run.js

You can’t perform that action at this time.