An open API service indexing awesome lists of open source software.

https://github.com/elomagic/dt-tool

Dependency Track Tool
https://github.com/elomagic/dt-tool

dependency-track dependencytrack sbom

Last synced: about 1 year ago
JSON representation

Dependency Track Tool

Awesome Lists containing this project

README

          

# Tool for Dependency Track

---

[![Apache License, Version 2.0, January 2004](https://img.shields.io/github/license/apache/maven.svg?label=License)][license]
[![build workflow](https://github.com/elomagic/dt-tool/actions/workflows/maven.yml/badge.svg)](https://github.com/elomagic/dt-tool/actions)
[![GitHub issues](https://img.shields.io/github/issues-raw/elomagic/dt-tool)](https://github.com/elomagic/dt-tool/issues)
[![Latest](https://img.shields.io/github/release/elomagic/dt-tool.svg)](https://github.com/elomagic/dt-tool/releases)
[![Maintenance](https://img.shields.io/badge/Maintained%3F-yes-green.svg)](https://github.com/elomagic/dt-tool/graphs/commit-activity)
[![Buymeacoffee](https://badgen.net/badge/icon/buymeacoffee?icon=buymeacoffee&label)](https://www.buymeacoffee.com/elomagic)

A tool that helps you to manage Dependency Track content better.

* Delete outdated projects
* Collect SBOMs of projects to one ZIP file
* tbc

## Using the library

Download the latest version of DT-Tool https://github.com/elomagic/dt-tool/releases

### Configuration

#### File ```${sys:user.home}/.dt-tool/configuration.json5```

The configuration `file, named ```configuration.json5```, must be placed in a sub folder named ```.dt-tool``` of the users home folder.

```json5
{
// Base URL of Dependency Track
"baseUrl": "https://dependencytrackapi.local",
// API key to access REST API of the Dependency Track
"apiKey": "",
}
```

### Execute

Execute following line to see all supported options:

```shell
dt-tool.sh --help
```

#### Example - Delete outdated SNAPSHOTS (30 days and older)

```shell
dt-tool.sh delete-projects -v
```

#### Example - Collect SBOMs

```shell
dt-tool.sh collect-boms -v --notBeforeDays=10 --projectFilter="b83457bd-5c89-4dc6-b6e1-eda408507dcd","117a619b-da93-4a85-8f8f-0e3ab9efce4c" -f="solution-stack-sboms.zip"
```

#### Example - Export simple report

```shell
dt-tool.cmd report -v --file dt-report.csv --decimalSymbol=, --fillGaps=true
```

#### Example - Print invalid license IDs

```shell
dt-tool.sh check-licenses -v --projectFilter="dt-tool"
```

## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](../../issues/new).

### Versioning

Versioning follows the semantic of [Semantic Versioning 2.0.0](https://semver.org/)

## License

The dt-tool is distributed under [Apache License, Version 2.0][license]

[license]: https://www.apache.org/licenses/LICENSE-2.0

## Donations

Donations will ensure the following:

* 🔨 Long term maintenance of the project
* 🛣 Progress on the roadmap
* 🐛 Quick responses to bug reports and help requests