# qbian-cli

> A cli tool-set to help create & provision minibian images. Raspberry pi

Latest version **0.2.5** (published 2016-03-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install qbian-cli
pnpm add qbian-cli
yarn add qbian-cli
bun add qbian-cli
```

Provides the command `qbian`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.2.5 |
| Published | 2016-03-08 |
| First published | 2016-01-04 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 7 |
| Author | Lee McKay |
| Maintainers | trojanspike |
| Keywords | emulate, raspberry, pi, qemu |

## Links

- npm: https://www.npmjs.com/package/qbian-cli
- Repository: https://github.com/trojanspike/qbian
- Homepage: https://github.com/trojanspike/qbian#readme
- Issues: https://github.com/trojanspike/qbian/issues
- npm.io page: https://npm.io/package/qbian-cli

## Alternatives

- [@openai/codex-sdk](https://npm.io/package/@openai/codex-sdk.md) — 731.4K weekly downloads
- [babel-plugin-transform-react-jsx](https://npm.io/package/babel-plugin-transform-react-jsx.md) — 565.0K weekly downloads
- [babel-helper-remove-or-void](https://npm.io/package/babel-helper-remove-or-void.md) — 508.5K weekly downloads
- [@pnpm/store-controller-types](https://npm.io/package/@pnpm/store-controller-types.md) — 186.9K weekly downloads
- [react-native-signature-canvas](https://npm.io/package/react-native-signature-canvas.md) — 155.6K weekly downloads

## Recent versions

- 0.2.5 (latest) — 2016-03-08
- 0.1.21 — 2016-02-03
- 0.1.18 — 2016-01-13
- 0.1.15 — 2016-01-08
- 0.1.13 — 2016-01-05
- 0.1.12 — 2016-01-05
- 0.1.5 — 2016-01-04
- 0.1.4 — 2016-01-04
- 0.1.0 — 2016-01-04

## README

# (qbian) qemu + minibian :: qbian

v 0.2.5

[![Gitter](https://badges.gitter.im/trojanspike/qbian.svg)](https://gitter.im/trojanspike/qbian?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=body_badge)

#### A cli tool-set to help create & provision minibian images

* Run on linux or vagrant VM linix machine ( TO BE COMPLETE , CONTRIBUTORS WELCOME ;) )
* Uses kpartx for mounting the *.img and editing with a provision script
* Uses qemu for emulation of the arm image.
* Toolset will be extended over time. i.e create new images & config with custom provisions.
* Automated provisioning & easy replication with imports & exports.
* I just created this for myself & it's not perfect. People are more than welcome to use it, make changes & improve it.

![Splash](https://raw.githubusercontent.com/trojanspike/qbian/images/qbian-raspflash.jpg "Splash image")

#### Envoironments Available:
[ qbain cloud 9 IDE interface ](https://github.com/trojanspike/qbian-cloud9)

_Add the cli into your bin_
```bash
$ git clone -b {release} {url}
$ ln -f /path/to/qbain/package/bin/qbain ~/bin/qbain
```
_Or install with npm_
```
$ npm install qbian-cli -g
```

#### _Quick example_

---
```bash
$ qbain init MyQbain # Will create the folder structure
$ cd MyQbain && \
$ qbain --create-default # creates a default image, uses the injects/default folder as injects
# After you create and the default image you can login using
$ ssh root@127.0.0.1 -p 5522 # OR if you have ssh configed to only allow ssh
$ qbain --ssh "root@127.0.0.1 -p 5522"
# At root home directory there'll be a Provision file to run
$ ./Provision.sh # all done halt image
# create a new image based on the default updated img
$ qbian --create-img updated "-redir tcp:8080::8080" 1G # create new images using the default img, Injects/updated folder required
$ qbian --list # list the images
# Use an already configured provsion i.e "example" one I've created
$ qbian --create-img example "-redir tcp:1374::1374 -redir tcp:8080::8080" 1G
# The example provision script will take a little while to complete. Add a user & password perdefined. add nvm & iojs with forever to run node. Add a quick express server & runs this at start up.
# Push to sd card - fdisk -l :: /dev/sdc < sd card >
$ qbian --export example /dev/sdc
# Now you can run on your device
```

```
$ qbian --skel MyEnv # Will create the inject folder you use for provisioning the image
$ qbian --create-img MyEnv "-redir tcp:8080::8080" 2.5G # Create the image and inject the MyEnv folder
$ qbian --run-img MyEnv 5522 # run the MyEnv image, port 5522 to ssh
# the provision should auto run because it was setup from the default image
```

![Running on qemu](/../images/run-img.png?raw=true "Running on qemu")
![cli help](/../images/help.png?raw=true "cli help")

#### _cli commands_
* init { 1 arg } [ Qbain env name ] Create a qbain env folder
* up { 0 args } Start the image defined from the Qbainfile
* --create-default { 0 args } Create the default image
* --create-img { 3 args } [ img-name , config , resize-img ] Create an image
* --run-img { 2 args } [ image-name , ssh-port ] Run an image in qemu
* --run-sd { 2 arg } [ sd-path, ssh-port ] Run an sd image in qemu
* --skel { 1 arg } [ skel-name ] Create a new empty skel with necessary files
* --list { 0 args } List available images
* --remove { 2 arg } [ image-name, remove-skel{bool,optional} ] Remove an image
* --clear { 0 args } Remove all images
* --export { 2 args } [ image-name , path{ sd-card , image-path } ] Export an image
* --import { 2 args } [ path{ sd-card , image-path } , image-name ] Import an image
* --ssh { 1 arg } [ ssh-options ] Use ssh key.
* --help { 0 args } Show help

note :
  To use the provision image I made you just need to edit file /Provision/minibian/BASE_IMAGE_TAR_URL,
  take note that the format needs to be tar.gz & image inside called 2015-02-18-wheezy-minibian.img

---

#### Possible Environments : TODO
* qbian-base : base for image for env's
* qbian-c9   : cloud9 IDE
* qbian-kodi : Kodi player with user auto login to kodi
* qbian-lightdm	:	debian display manager

#### Known issues
* When kpartx is ran it might auto mount which will cause the cli to exit on an error.

#### TODO:

- [ ] Output stdout to log file /imageName/output.log
- [ ] Output stderr to log file /imageName/error.log # hopefully none
- [ ] Quiet down with minibian-qemu.sh script , clear , echo info to user & put to log file
- [ ] Checks folder and files are avail , else either create or error out
- [ ] Error Checks in /bin/qbain
- [ ] Make tar minibian file configurable with a config file

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