/node-supervisord

📕 ~ A Node.js library for communicating with the Supervisord XML-RPC API

Primary LanguageTypeScriptMIT LicenseMIT

Supervisord

node-supervisord

A Node.js library for communicating with the Supervisord XML-RPC API

GitHub release License

Installation & Usage

Install node-supervisord using npm:

npm install --save node-supervisord

Install node-supervisord using yarn:

yarn add node-supervisord

Example usage :

import { SupervisordClient } from "node-supervisord";

// Without authentication options
const client = new SupervisordClient("http://localhost:9001");

// With authentication options
const client = new SupervisordClient("http://localhost:9001", {
  username: "your-username",
  password: "your-passwword",
});

// Example get api version
const version = await client.getAPIVersion();
console.log(version);

To see the available methods, you can visit http://supervisord.org/api.html

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

Releasing

  1. Go to Publish Release page, click Run workflow
  2. Fill the vendor version and then run the flow
  3. GitHub Actions will take care of the rest

License

This project is licensed under the MIT License - see the LICENSE.md file for details.

Acknowledgments

Inspiration, code snippets, icon, etc.