Giter VIP home page Giter VIP logo

libdotbc's Introduction

.bc file format utilities

Both a native library and a CLI tool are provided.

Building

Building the library and CLI tool requires the following:

  • The Rust compiler, version 1.10 or greater.
  • Make

After cloning this repository, run cargo build in the root directory. This will compile the CLI tool into the target/debug/ directory.

Usage

Here is how you can get started with the dotbc CLI tool.

Getting a list of supported commands

dotbc -h

Output:

dotbc

A utility providing access to the .bc file type.

Usage:
    dotbc <cmd> [<args>...]
    dotbc (-h | --help)
    dotbc --version

Options:
    -h, --help      Show this message
    --version       Print the version

The most commonly used commands are:
    ls-files         List all files in a .bc archive
    read-file        Read a file contained by a .bc archive
    show-metadata    Show the .bc metadata as JSON
    write-file       Write a file to a .bc archive

You can then run dotbc <cmd> -h for usage documentation for each command.

Creating a new .bc archive

dotbc write-file -cf hello-world.bc hello.txt 'hello world'

This creates a new .bc archive, hello-world.bc. It writes the string 'hello world' at hello.txt inside the archive.

Listing the contents of a .bc archive

dotbc ls-files -f hello-world.bc

Output:

hello.txt

Reading a file contained in a .bc archive

dotbc read-file -f hello-world.bc hello.txt

Output:

hello world

License

libdotbc and the dotbc CLI tool are distributed under the terms of the MIT license. See LICENSE for details.

libdotbc's People

Contributors

carllerche avatar

Watchers

James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.