From b634ba2a085905b431da872aaf38fc1b378b3dde Mon Sep 17 00:00:00 2001 From: Mansour Baitar Date: Sat, 13 Jan 2024 05:22:48 +0100 Subject: [PATCH 1/3] Added examples for cli usage --- README.md | 54 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 54 insertions(+) diff --git a/README.md b/README.md index a5df07e..3b03fb8 100644 --- a/README.md +++ b/README.md @@ -123,3 +123,57 @@ Call the Wasm function Request Body: `any` (passed to function) Response Body: `any` (returned from function) + +## Raptor CLI + +## Supported runtimes +| Runtime | CLI value | +|------------|-----------| +| Javascript | js | +| Golang | go | + +### Create endpoint + +```cmd +./bin/raptor endpoint --runtime --name "My application name" +``` +Example Response: +```json +{ + "id": "60afbade-ce43-416e-8d7a-62f3f5ed5f8e", + "name": "My application name", + "runtime": "js", + "active_deployment_id": "00000000-0000-0000-0000-000000000000", + "environment": {}, + "deployment_history": [], + "created_at": "2024-01-13T04:57:37.916478+01:00" +} +``` + +### Create preview deploy +```cmd +./bin/raptor deploy --endpoint --file . +``` +Example Response: +```json +{ + "id": "3194253c-ef0b-4f7a-a3a6-0669aa533ec0", + "endpoint_id": "60afbade-ce43-416e-8d7a-62f3f5ed5f8e", + "hash": "949614f7bdf32b8b4f6bb969a3674a33", + "created_at": "2024-01-13T05:02:16.22648+01:00" +} +``` +You will be able to access the deploy preview on `deploy preview: http://0.0.0.0:80/preview/` + +### Publish created deploy +```cmd +./bin/raptor publish --deploy +``` +Example Response: +```json +{ + "deployment_id": "3194253c-ef0b-4f7a-a3a6-0669aa533ec0", + "url": "http://0.0.0.0:80/live/60afbade-ce43-416e-8d7a-62f3f5ed5f8e" +} + +``` \ No newline at end of file From cb72cfe5c4f019bd2ecf62f2ad160cbb05727958 Mon Sep 17 00:00:00 2001 From: Mansour Baitar Date: Sat, 13 Jan 2024 05:29:46 +0100 Subject: [PATCH 2/3] update readme with a typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 3b03fb8..02c676b 100644 --- a/README.md +++ b/README.md @@ -163,7 +163,7 @@ Example Response: "created_at": "2024-01-13T05:02:16.22648+01:00" } ``` -You will be able to access the deploy preview on `deploy preview: http://0.0.0.0:80/preview/` +You will be able to access the deploy preview on: `http://0.0.0.0:80/preview/` ### Publish created deploy ```cmd From 7dada11ba682e0d4e7908d60587a6bb13c8f5d3a Mon Sep 17 00:00:00 2001 From: Mansour Baitar Date: Sat, 13 Jan 2024 09:46:43 +0100 Subject: [PATCH 3/3] Added discord and license to readme --- README.md | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 02c676b..a846853 100644 --- a/README.md +++ b/README.md @@ -176,4 +176,14 @@ Example Response: "url": "http://0.0.0.0:80/live/60afbade-ce43-416e-8d7a-62f3f5ed5f8e" } -``` \ No newline at end of file +``` + +# Community and discussions +Join our Discord community with over 2000 members for questions and a nice chat. +
+ +Discord Banner + + +# License +Raptor is licensed under the Apache-2.0 licence. \ No newline at end of file