https://github.com/codesandtags/backstage-toolkit
Help teams to generate and validate its Backstage Entities
https://github.com/codesandtags/backstage-toolkit
Last synced: 2 months ago
JSON representation
Help teams to generate and validate its Backstage Entities
- Host: GitHub
- URL: https://github.com/codesandtags/backstage-toolkit
- Owner: codesandtags
- Created: 2023-08-17T15:41:05.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-16T23:17:55.000Z (over 2 years ago)
- Last Synced: 2025-12-27T02:54:33.529Z (6 months ago)
- Language: TypeScript
- Size: 68.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Backstage Toolkit
Help teams to generate and validate their `Backstage Entities` for their `Backstage Catalog`.
## How to use it?
1. Install the `backstage-toolkit`:
```bash
npm install -g backstage-toolkit
```
2. Generate the catalog:
```bash
backstage-toolkit generate-catalog --help
```
## Features
### Generate fake catalog
Generate a fake catalog based on the configuration file `backstage-toolkit.config.js`.
```bash
backstage-toolkit generate --fake
```
### Setup custom entities for your catalog
Create a file `backstage-toolkit.config.js` in the root of your project with the following content, to setup your custom entities:
```json
{
"output": "tmp",
"generator": {
"groups": 10,
"components": 2500,
"apis": 8400,
"domains": 5,
"systems": 10,
"relations": true,
"openapiDefinition": "https://github.com/APIs-guru/openapi-directory/blob/dab6854d4d599aafb0eb36e6c7ae1fe0c37509b7/APIs/spotify.com/2021.4.2/openapi.yaml"
},
"approach": "centralized"
}
```
## How to install this repo locally?
1. Clone the repo:
```bash
git clone
```
2. Install the dependencies:
```bash
npm install
```
1. Include the backstage-toolkit `cli` globally to run it from anywhere:
```bash
npm install -g ./
backstage-toolkit --help
```