gbb

README

ifdef::env-github[]
:tip-caption: :bulb:
:note-caption: :information_source:
:important-caption: :heavy_exclamation_mark:
:caution-caption: :fire:
:warning-caption: :warning:
endif::[]
:sonar-project-id: mortedecai_go-burn-bits
:sonar-token: &token={REMOVE_ME_IF_NOT_PRIVATE}

:img-quality-gate: https://sonarcloud.io/api/project_badges/measure?project={sonar-project-id}&metric=alert_status{sonar-token}
:img-coverage: https://sonarcloud.io/api/project_badges/measure?project={sonar-project-id}&metric=coverage{sonar-token}
:img-maintainability: https://sonarcloud.io/api/project_badges/measure?project={sonar-project-id}&metric=sqale_rating
:img-security-rating: https://sonarcloud.io/api/project_badges/measure?project={sonar-project-id}&metric=security_rating
:img-reliability: https://sonarcloud.io/api/project_badges/measure?project={sonar-project-id}&metric=reliability_rating
:img-techdebt: https://sonarcloud.io/api/project_badges/measure?project={sonar-project-id}&metric=sqale_index

:uri-analysis: https://sonarcloud.io/summary/new_code?id={sonar-project-id}

= Go Burn Bits (gbb)

The intent of this repository is to provide command line utilities easing local development of scripts for use in the https://github.com/bitburner-official/bitburner-src[Bit Burner] game.

== Project Health

[.text-center]

|===
|image:{img-quality-gate}[Quality Gate,link={uri-analysis}]|image:{img-coverage}[Coverage,link={uri-analysis}] |image:{img-maintainability}[Maintainability,link={uri-analysis}]

|image:{img-reliability}[Reliability,link={uri-analysis}]
|image:{img-security-rating}[Security Rating,link={uri-analysis}]
|image:{img-techdebt}[Technical Debt,link={uri-analysis}]

|===

== Installation

To install the executable:

`go install github.com/mortedecai/gbb@latest`

== Usage

=== Retrieve all files from BitBurner

This will retrieve all files from the BitBurner API Server and write them blindly to the output directory.

The output directory _*MUST*_ be a sub-directory of where `gbb` is being run from.

WARN: All existing files in `outputDir` will be overwritten without confirmation.

```shell
client download --authToken <BitBurner auth token> --outputDir <output directory>
```

For example, to download them to `/var/bb`, with an auth token `abc`:

```shell
client download --authToken abc --outputDir /var/bb
```