Bennyfile (Benfile Parser For Benny)

Benfile parsing library that converts a Benfile to a JSON object and then back to the original format.

Table of Contents

• Background
• Installation
• Usage
• API
• Related Projects
• Why Decentralized Internet
• Bench On The dWeb
• License
• Copyright

Background

Benfiles are basically installer-steps for Benny, benOS' native container builder and management software. This library was created to parse and delivery the installation steps within a Benfile in JSON format, to Benny for execution.

With NPM

npm install bennyfile

With YARN

yarn add bennyfile

Usage

var bennyfile = require('bennyfile')

var parsedBenny = bennyfile.parseBenny(`
  FROM ubuntu:xenial
  RUN rm -f /etc/resolv.conf && echo '8.8.8.8' > /etc/resolv.conf
  RUN apt-get update
  RUN apt-get install -y git vim curl
  RUN curl -fs https://raw.githubusercontent.com/benchOS/getnjs/master/go | sh
  RUN node-install 8.9.1
`)

// prints the parsedBenny file
console.log(parsedBenny)

// serializes it again
console.log(bennyfile.stringify(parsedBenny))

Syntax

The Benfile formatting is similar to a Dockerfile, just easier and shorter.

VIA os:version
GO shell-command
TO from/local/file /to/container/path
IN key=value key2=value2
DO key=value

Alternatively if you are referencing another Benfile or disk image you can do

VIA ./path/to/disk/image/or/Benfile

If your shell command is long you can split it into multiple lines using the familiar \\ syntax

GO apt-get update && \\
  apt-get install -y git vim curl

To comment out a line add # infront.

To force run a command (i.e. cache bust it) you can prefix any command with FORCE.

API

var parsedBenny = bennyfile.parseBenny(string)

Parse the content of a Benfile. Returns an array of objects, each representing a line.

// VIA os:version
{
  type: 'via',
  image: 'os',
  version: 'version',
  path: null
}

// VIA ./path
{
  type: 'via',
  image: null,
  version: null,
  path: './path'
}

// GO command
{
  type: 'go',
  command: 'command'
}

// TO from to
{
  type: 'to',
  from: 'from',
  to: 'to'
}

// IN key=value key2="value 2" ...
{
  type: 'in',
  env: [{
    key: 'key',
    value: 'value'
  }, {
    key: 'key2',
    value: 'value 2'
  }]
}

// DO key=value
{
  type: 'do',
  key: 'key',
  value: 'value'
}

// DO key
{
  type: 'do',
  key: 'key',
  value: null
}

If a command is prefixed with FORCE, force: true will be set on the object.

var str = bennyfile.stringify(parsedBenny)

Convert a parsedBenny JS object (JSON Formatted version of Benfile) back to the original Benfile format

Related Projects

• benOS - benOS Decentralized Operating System
• benny - benOS Native Container Builder
• gospawn - Bootstrap Spawner For Benny
• bennyfile - Build File Library For Benny Containers
• thinbit - BitField Library For Benny

Why The Internet Must Have A Decentralized Alternative

Today, the internet is more censored than ever and it's only getting worse. Our mission with the dWeb Protocol was to create a truly powerful P2P protocol, around benOS, dBrowser and many of benOS' underlying libraries to bring the most powerful P2P products to life. In the last few months, by rebuilding P2P technologies that have existed since the early 2000s, we have built a powerful suite of decentralized libraries for benOS and the Bench Network, that will only improve over time. But we also brought new ideas to life, like:

• dDrive
• dExplorer
• dDatabase
• dSites
• dPack
• benFS
• DCDN
• Rocketainer
• RocketOS
• dNames
• P2PDNS
• dWebFS
• dWebDB
• MeteorIDE
• Kepler
• Neutron
• Designate
• Nova

and more! These were the protocols and libraries that we needed to create a completely decentralized operating system, where everything was distributed, protected and people were once again in control of their data. benOS is made up of over 1100+ different libraries that we are releasing on a day-by-day basis as we move them to a stable/production state. While financial support is great for this open source project, we need developers who want to be some of the first to build the dApps and dSites of the future. We have to take back what our forefathers originally designed for freedom, by making our code the law, instead of releasing weak and highly centralized applications where law cannot be applied because the code lacks the foundation to implement a legal framework for itself. Join us for a truly historic journey on the BenchLabs Telegram. See you there.

Bench On The dWeb

dweb://bench.dnames.io // dNames Short Link dweb://3EDAE09848B77401445B7739CAFCE442DDE1752AED63025A1F94E6A86D7E9F04 // dWeb Key Link

In order to make the links above clickable or to view these links period, you will need dBrowser (Available for Mac OSX, Linux, Windows and soon to be available on iOS/Android)

"The Code Is The Law" - Stan Larimer - Godfather of BitShares.

License

MIT

Copyright

Copyright (c) 2018 Bench Open Systems. All rights reserved.