# bipbip.js

> Bipbip is a deploy tool

Latest version **0.12.1** (published 2026-04-02) · MIT license · 0 weekly downloads

## Install

```sh
npm install bipbip.js
pnpm add bipbip.js
yarn add bipbip.js
bun add bipbip.js
```

Provides the command `bipbip`.

## Health

**Score 45/100 (D)** — status: stable.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

## Facts

| | |
|---|---|
| Version | 0.12.1 |
| Published | 2026-04-02 |
| First published | 2015-11-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 66.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 22 |
| Author | Baptiste Donaux |
| Maintainers | baptistedonaux |
| Keywords | bipbip, deploy, tool |

## Links

- npm: https://www.npmjs.com/package/bipbip.js
- Repository: https://github.com/baptistedonaux/bipbip.js
- Homepage: https://github.com/baptistedonaux/bipbip.js#readme
- Issues: https://github.com/baptistedonaux/bipbip.js/issues
- npm.io page: https://npm.io/package/bipbip.js

## Dependencies (2)

- [chalk](https://npm.io/package/chalk.md) 2.3.*
- [commander](https://npm.io/package/commander.md) 2.12.*

## Alternatives

- [lodash.assign](https://npm.io/package/lodash.assign.md) — 2.3M weekly downloads
- [lodash.chunk](https://npm.io/package/lodash.chunk.md) — 1.8M weekly downloads
- [react-native-ios-utilities](https://npm.io/package/react-native-ios-utilities.md) — 138.5K weekly downloads
- [@technically/lodash](https://npm.io/package/@technically/lodash.md) — 50.9K weekly downloads
- [@fluid-topics/ft-icon](https://npm.io/package/@fluid-topics/ft-icon.md) — 20.6K weekly downloads

## Recent versions

- 0.12.1 (latest) — 2026-04-02
- 0.12.0 — 2026-03-12
- 0.11.1 — 2024-10-02
- 0.11.0 — 2023-11-30
- 0.10.13 — 2023-07-28
- 0.10.12 — 2018-05-15
- 0.10.11 — 2017-12-22
- 0.10.10 — 2017-12-22
- 0.10.9 — 2017-12-21
- 0.10.8 — 2017-12-21
- 0.10.7 — 2017-12-21
- 0.10.6 — 2017-12-21
- 0.10.5 — 2017-12-21
- 0.10.4 — 2017-12-21
- 0.10.3 — 2017-12-21
- … 30 more at https://npm.io/package/bipbip.js/versions

## README

# Bipbip.js - Simple deployment tool

[![Build Status](https://travis-ci.org/baptistedonaux/bipbip.js.svg?branch=0.12)](https://travis-ci.org/baptistedonaux/bipbip.js)
[![DUB](https://img.shields.io/dub/l/vibe-d.svg)](LICENSE)

Bipbip.js is a simple tool to deploy, based on Node.js.

![Bipbip.js](bipbip-logo-text.svg)

## Installation

```bash
$ npm install -g bipbip.js@0.12.*
```
## Getting Started
### Run a deployment
```bash
$ bipbip <env>

# Run prod env
$ bipbip prod
```

### Configuration
bipbip.js takes the ```deploy.js``` default file. The file takes a default configuration and supports environments.

The environment called is merged with ```default``` environment.

```javascript
exports.config = {
  default: {
  },
  <env1>: {
  },
  <env2>: {
  }
}
```

### Environment variables
```javascript
workspace: "/path/to/workspace",
// empty string in releaseDir is used to deploy current folder (workspace)
releaseDir: "",
requirements: {
    local: [],
    remote: []
},
servers: [{
  user: "user",
  host: "server_to_deploy.io",
  to: "/path/to/deploy",
  port: 22
}],
repository: {
  url: "git@github.com:baptistedonaux/bipbip.js.git",

  // branch and tag should not be sets simultaneously
  branch: null,
  tag: null,
  
  options: {
    // clone submodule
    submodules: true|false
  }
},
commands:  {
  local: [
    // local commands to run (before send to remote server)
  ],
  remote: [
    // remote commands to run (after project send to remote server)
  ],
  postDeploy: [
    // remote commands to run (after new release deployed)
  ]
},
ignores: [
  // ignore files/folders
],
shared: {
  files: [
    // files shared
  ],
  folders: [
    // folders shared
  ]
},
releases: 3
```

#### Required values
```javascript
{
  servers: [{
    user: "User to connect the remote server",
    host: "Server to deploy",
    to: "Absolute path where deploy"
  }]
}
```

#### Default values
```javascript
{
  workspace: require("process").cwd(),
  requirements: {
    local: [],
    remote: []
  },
  servers: [{
    port: 22
  }],
  repository: {
    branch: null,
    options: {
      submodules: false
    },
    tag: null,
    url: null
  },
  commands:  {
    local: [],
    remote: [],
    postDeploy: []
  },
  ignores: [],
  shared: {
    files: [],
    folders: []
  },
  releases: 3
}
```

## Test
```bash
$ npm test
```

## Contribute
```bipbip.js``` is a simple project. No specific or complexe features will are developped. For bugs and features, open an [issue](https://github.com/baptistedonaux/bipbip.js/issues).

---
_Source: https://npm.io/package/bipbip.js · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._