> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# rookout/rookout-node

A circle-ci orb that installs rookout-node to your job and runs your node program with rookout.
Explore our github repository for further information: https://github.com/Rookout/circle-ci-orbs.
Orb dependencies: bash, nodejs, npm, sudo\root access.


## Commands

### run_script

Specify your ROOKOUT_TOKEN in your circle-ci project Environment Variables

| Parameter | Type | Default | Description |
|---|---|---|---|
| `users_script` | string |  | Your node command that you wish to debug |
| `rookout_tags` | string | $CIRCLE_PROJECT_REPONAME;$CIRCLE_JOB;circle-ci | The list of tags you want for your application instances. Use ; as a separator |

## Examples

### simple-node-debugging

Simple circle-ci file that imports and uses the orb

```yaml
orbs:
  rookout-node: rookout/rookout-node@0.0.8
description: A circle-ci job that uses rookout-node to debug a node command
jobs:
  my_job:
    docker:
      - image: circleci/node:10
    working_directory: ~/Temp
    steps:
      - rookout-node/run_script:
          users_script: node %YOUR_NODE_COMMAND%
          rookout_tags: yourTag1;yourTag2
version: 2.1
workflows:
  main:
    jobs:
      - my_job
```