Skip to content

Commit f8d5df8

Browse files
authored
Update README.md
1 parent 52fa89f commit f8d5df8

File tree

1 file changed

+47
-2
lines changed

1 file changed

+47
-2
lines changed

README.md

+47-2
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,47 @@
1-
# WIP aidbox-sdk
2-
Aidbox SDK
1+
![](https://github.com/aidbox/aidbox-sdk/actions/workflows/build.yaml/badge.svg)
2+
3+
# Aidbox SDK Generator
4+
5+
A CLI tool to generate Aidbox SDKs for various programming languages from FHIR schema definitions.
6+
7+
8+
## Getting Started
9+
10+
### Prerequisites
11+
12+
- Ensure you have a working instance of Aibox to retrieve the FHIR Schemas.
13+
14+
- Ensure that Aidbox security policies allow access to `/api/sdk/fhir-packages` endpoint. For a simple setup, you can add a client and configure basic authentication as described [here](https://docs.aidbox.app/modules-1/security-and-access-control/auth/basic-auth#register-client)
15+
- Use your Aidbox client's username and password to generate a token for the aidbox SDK generator using the following formula:
16+
`base64(user:password)`
17+
18+
### Installation
19+
20+
Download latest version from [the release page](https://github.com/Aidbox/aidbox-sdk/releases).
21+
22+
### Usage
23+
24+
To generate an SDK, use the following command:
25+
26+
```bash
27+
aidbox-sdk generate <target-language> <input-source> --auth-token <aidbox-client-token>
28+
```
29+
30+
Example:
31+
32+
```bash
33+
aidbox-sdk generate dotnet http://localhost:8765/api/sdk/fhir-packages ---auth-token YmFzaWM6c2VjcmV0
34+
```
35+
36+
37+
38+
### Options
39+
40+
- `--help`: Display help information
41+
- `--output-dir <directory>` : Directory to ouput the generated SDK.
42+
- `--auth-token <token>` : Provide and authentication token
43+
44+
45+
46+
47+

0 commit comments

Comments
 (0)