https://github.com/adaltas/node-nikita

Automation and deployment solution with Node.js
https://github.com/adaltas/node-nikita

automation deployment devops nodejs ssh

Last synced: 12 days ago
JSON representation

Automation and deployment solution with Node.js

• Host: GitHub
• URL: https://github.com/adaltas/node-nikita
• Owner: adaltas
• License: mit
• Created: 2012-02-12T15:59:57.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2024-10-24T22:32:04.000Z (19 days ago)
• Last Synced: 2024-10-27T17:04:32.867Z (16 days ago)
• Topics: automation, deployment, devops, nodejs, ssh
• Language: CoffeeScript
• Homepage: https://nikita.js.org
• Size: 39 MB
• Stars: 62
• Watchers: 10
• Forks: 20
• Open Issues: 36
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Build Status](https://secure.travis-ci.org/adaltas/node-nikita.svg)](http://travis-ci.org/adaltas/node-nikita)

# Node.js Nikita

Nikita gathers a set of functions commonly used during system deployment.

Documentation is available on the [project website](https://nikita.js.org).

## Main features

* Consistent Usage   

  All the functions share the same API, accepting configuration in a flexible manner validated by a schema. Once you learn the core usage, you only learn the configuration of the actions you wish to execute.

* Everything is a file   

  No agent to install, no database to depend on. Your project is just another Node.js package easily versionned in Git and any SCM, easily integrated with your CI and CD DevOps tools.

* Idempotence   

  Call a function multiple times and expect the same result. You’ll be informed of any modification and can retrieve detailed information.

* Documentation   

  Learn fast. Source code is self-documented with the most common uses enriched by many examples. Don’t forget to look at the tests as well.

* Flexibility   

  Deliberately sacrificing speed for a maximum of strength, ease of use, and flexibility. The simple API built on a plugin architecture allows us to constantly add new functionalities without affecting the API.

* Composition   

  Built from small and reusable actions imbricated into a complex system. It follows the Unix philosophy of building small single-building blocks with a clear API.

* SSH support   

  All the functions run transparently over SSH. Look at the tests, they are all executed both locally and remotely.

* Reporting   

  Advanced reports can be obtained by providing a log function, listening to stdout and stderr streams, generating diffs and backups.

* Reliability   

  Feel confident. Modules are used in production for years and the code is enforced by an extensive test coverage.

* Support   

  The package is open sourced with one of the least restrictive licenses. Involve yourself and contribute to open source development by sending pull requests or requesting commercial support offered by [Adaltas](http://www.adaltas.com).

## Installation

```bash

npm install nikita

```

## Developer information

Refer to the documentation to learn more and get involved:

* The [general project architecture](https://nikita.js.org/project/architecture/).

* Become a [contributor](https://nikita.js.org/project/contribute/).

* How to setup a [developer and testing environment](https://nikita.js.org/project/developers/).