https://github.com/open-node/antman

Debug node.js process by client REPL on net socket and is silent
https://github.com/open-node/antman

debug-is-silent debugger process-debug repl-debug

Last synced: 2 months ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/open-node/antman
• Owner: open-node
• License: mit
• Created: 2019-11-20T09:11:35.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2019-11-26T10:30:30.000Z (over 5 years ago)
• Last Synced: 2025-03-27T15:52:15.692Z (3 months ago)
• Topics: debug-is-silent, debugger, process-debug, repl-debug
• Language: JavaScript
• Size: 89.8 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# @open-node/antman

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

[![Build status](https://travis-ci.com/open-node/antman.svg?branch=master)](https://travis-ci.org/open-node/antman)

[![codecov](https://codecov.io/gh/open-node/antman/branch/master/graph/badge.svg)](https://codecov.io/gh/open-node/antman)

# 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

![antman demo](./assets/demo.gif)

### Table of Contents

-   [Antman][1]

    -   [regist][2]

        -   [Parameters][3]

    -   [start][4]

        -   [Parameters][5]

-   [antman][6]

## Antman

Returns **[Antman][7]** Instance

### regist

regist variable on agents

#### Parameters

-   `key` **[string][8]** 

-   `value` **any** 

-   `description` **[string][8]?**  (optional, default `"Undefined description text"`)

Returns **void** 

### start

start socket server

#### Parameters

-   `listen` **[string][8]** listen address，port or ip+port or sock-file-path, (optional, default `9085`)

-   `secret` **[string][8]** OTP secret default null, unnecessary when secret be null (optional, default `null`)

-   `opt` **[object][9]?** { expire: 900 } (optional, default `defaultOpt`)

Returns **void** 

## antman

[1]: #antman

[2]: #regist

[3]: #parameters

[4]: #start

[5]: #parameters-1

[6]: #antman-1

[7]: #antman

[8]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String

[9]: https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object