https://github.com/o7studios/octopus-sdk
API & SDKs for o7studios product Octopus
https://github.com/o7studios/octopus-sdk
Last synced: about 1 month ago
JSON representation
API & SDKs for o7studios product Octopus
- Host: GitHub
- URL: https://github.com/o7studios/octopus-sdk
- Owner: o7studios
- License: gpl-3.0
- Created: 2025-08-01T07:00:12.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2026-05-22T15:45:37.000Z (about 1 month ago)
- Last Synced: 2026-05-22T20:27:08.960Z (about 1 month ago)
- Language: Makefile
- Homepage: https://docs.o7.studio/docs/octopus/api
- Size: 611 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Octopus API & SDKs
Source protobufs and generated SDKs for the Octopus product.
## What's here
- `proto/` Protocol Buffer definitions (versioned)
- `sdk/` Generated SDKs: Go, Java, TypeScript, and OpenAPI
- `buf.yaml`, `buf.gen.yaml` Buf config for linting and generation
## Requirements
- [Buf](https://buf.build/) for code generation
- `make` (optional) for the helper target
## Generate SDKs
```sh
make generate-proto
```
This removes existing generated output in `sdk/` and regenerates from `proto/` via `buf`.
## Install SDKs
### Go
```sh
go get github.com/o7studios/octopus-sdk@latest
```
### TypeScript / JavaScript
```sh
npm install @o7studios/octopus-sdk
```
### Java
Maven Central:
```kotlin
// build.gradle.kts
dependencies {
implementation("studio.o7:octopus-sdk:VERSION")
}
```