open-node / antman

Debug node.js process by client REPL on net socket and is silent

@open-node/antman

Debug node.js process by client REPL on net socket and is silent.

Installation

npm i @open-node/antman --save

Usage

• your node.js process code

const antman = require('@open-node/antman')();

// regist variable on agents object
antman.regist('key', value, 'description');

// start debugger server
antman.start(listen, secret, { expire: 30 * 60 });

• Execute the following command then enter REPL mode to debug

antman connect 9085

• REPL debugger mode

`$` is the agent whose be debugged node.js process
`help` is tips info for you

cli tool antman demo

Table of Contents

• Antman
  • regist
    • Parameters
  • start
    • Parameters
• antman

Antman

Returns Antman Instance

regist

regist variable on agents

Parameters

• key string
• value any
• description string? (optional, default "Undefined description text")

Returns void

start

start socket server

Parameters

• listen string listen address，port or ip+port or sock-file-path, (optional, default 9085)
• secret string OTP secret default null, unnecessary when secret be null (optional, default null)
• opt object? { expire: 900 } (optional, default defaultOpt)

Returns void

antman