Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/readme/strip.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
<a href="https://github.com/AntelopeJS/antelopejs"><img data-illustration src="./.github/readme/strip.svg" width="100%" alt="TOOLING · CLOUD SDK: part of AntelopeJS, hexagonal architecture beyond your own code. A glowing button reads Star AntelopeJS."></a>

<div align="center">

# AntelopeJS Cloud SDK and CLI

<a href="https://www.npmjs.com/package/@antelopejs/cloud-sdk"><img data-illustration alt="npm @antelopejs/cloud-sdk" src="https://img.shields.io/npm/v/@antelopejs/cloud-sdk?label=cloud-sdk&style=for-the-badge&labelColor=000000&color=000000"></a> <a href="https://www.npmjs.com/package/@antelopejs/cloud"><img data-illustration alt="npm @antelopejs/cloud" src="https://img.shields.io/npm/v/@antelopejs/cloud?label=cloud&style=for-the-badge&labelColor=000000&color=000000"></a> <a href="#license"><img data-illustration alt="License" src="https://img.shields.io/npm/l/@antelopejs/cloud-sdk?style=for-the-badge&labelColor=000000&color=000000"></a> <a href="https://discord.gg/g4pFt6eXqu"><img data-illustration alt="Discord" src="https://img.shields.io/badge/Discord-18181B?logo=discord&style=for-the-badge&color=000000"></a> <a href="./cli/README.md"><img data-illustration alt="Documentation" src="https://img.shields.io/badge/Docs-18181B?style=for-the-badge&color=000000"></a> <a href="https://github.com/AntelopeJS/antelopejs"><img data-illustration alt="Star AntelopeJS" src="https://img.shields.io/github/stars/AntelopeJS/antelopejs?label=Star%20AntelopeJS&style=for-the-badge&labelColor=000000&color=000000&logo=github"></a>

**Antelope Cloud SDK (@antelopejs/cloud-sdk) and CLI (@antelopejs/cloud)**

[CLI documentation](./cli/README.md) · [SDK documentation](./sdk/README.md) · [All interfaces and providers](https://github.com/AntelopeJS/antelopejs#ecosystem)

</div>

This repository holds the two public npm packages of AntelopeJS Cloud:

- `@antelopejs/cloud-sdk` in [`sdk/`](sdk/README.md) is a typed client for the AntelopeJS Cloud API. Its types are generated from the OpenAPI spec in `sdk/openapi/`, which the package also ships.
Expand Down Expand Up @@ -108,3 +120,11 @@ The CLI depends on a range of SDK versions, so release in this order:
3. Run the workflow with `package: cli`. The first CLI release also sets `release-version` to `0.1.0`.

The CLI run fails before it publishes when no version of `@antelopejs/cloud-sdk` that matches its range is on npm. When a CLI change needs a new SDK release, raise the range in `cli/package.json` and release the SDK first.

## Part of AntelopeJS

This tooling belongs to [AntelopeJS](https://github.com/AntelopeJS/antelopejs), the TypeScript framework where modules depend on contracts and the application chooses the provider. The open-source back office [AntelopeJS DMS](https://github.com/AntelopeJS/dms) is built on it.

## License

Both packages are licensed under Apache-2.0, as declared in [`sdk/package.json`](./sdk/package.json) and [`cli/package.json`](./cli/package.json).
2 changes: 1 addition & 1 deletion cli/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@
},
"devDependencies": {
"@antelopejs/core": "^1.21.0",
"@antelopejs/tooling-configs": "^0.5.2",
"@antelopejs/tooling-configs": "^0.5.5",
"@types/busboy": "^1.5.4",
"@types/node": "^22.19.15",
"@types/tar-stream": "^3.1.4",
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
"knip": "knip"
},
"devDependencies": {
"@antelopejs/tooling-configs": "^0.5.2",
"@antelopejs/tooling-configs": "^0.5.5",
"@types/node": "^22.20.5",
"knip": "^6.34.0",
"lefthook": "^2.2.2",
Expand Down
18 changes: 9 additions & 9 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions pnpm-workspace.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,5 @@ overrides:
"brace-expansion@>=5.0.0 <5.0.11": "^5.0.11"
"js-yaml@>=4.0.0 <4.3.2": "^4.3.2"
"tinypool@>=2.0.0 <2.1.2": "^2.1.2"
allowBuilds:
lefthook: false
2 changes: 1 addition & 1 deletion sdk/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"openapi-fetch": "^0.14.0"
},
"devDependencies": {
"@antelopejs/tooling-configs": "^0.5.2",
"@antelopejs/tooling-configs": "^0.5.5",
"@types/node": "^22.19.15",
"openapi-typescript": "^7.9.1",
"oxfmt": "^0.77.0",
Expand Down
Loading