{"templateId":"markdown","sharedDataIds":{},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Caraer CLI","description":"Developer documentation for the Caraer platform. REST API reference, Bearer authentication, tutorials, and guides for records, forms, webpages, webhooks, and automations.","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"caraer-cli","__idx":0},"children":["Caraer CLI"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The Caraer CLI (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caraer-cli"]},") is the downloadable developer tool for managing"," ","Caraer apps, webhooks, serverless functions, schedules, inbound routes, and"," ","local developer projects."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"install","__idx":1},"children":["Install"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"pipx install caraer-cli\n# or from a local checkout:\npip install -e \".[dev]\"\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"core-workflows","__idx":2},"children":["Core workflows"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"caraer auth login --email you@example.com\ncaraer company select <company-uuid>\ncaraer apps init --label \"My Sync App\"\ncd my_sync_app\ncaraer apps add function sync-handler\ncaraer apps add schedule renew-watch --function sync-handler\ncaraer apps add inbound provider-push --function sync-handler\ncaraer apps push --deploy\ncaraer apps local logs\ncaraer apps local dev\ncaraer sandbox create --name my-sandbox\n","lang":"bash"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Developer project mutations require the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["app creator company"]}," (or super-admin)."," ","Knowing an app UUID alone is not authorization."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Typed serverless payloads live in the Caraer clients (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["@caraer/client"]}," /"," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caraer-client"]},")."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":3},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Tutorial: ",{"$$mdtype":"Tag","name":"a","attributes":{"href":"/blog/2026-08-23-how-to-create-a-caraer-app"},"children":["How to create a Caraer app"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"a","attributes":{"href":"/blog/2026-03-25-serverless-functions-in-caraer-apps"},"children":["Serverless functions in Caraer apps"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Source: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["caraer-cli"]}," repository"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Platform APIs: Caraer Java Backend (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["/api/v2/apps"]},", installation runtime, developer-projects)"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Runtimes: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["nodejs22"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["python312"]}," on Google Cloud Functions (V2: one container per app)"]}]}]},"headings":[{"value":"Caraer CLI","id":"caraer-cli","depth":1},{"value":"Install","id":"install","depth":2},{"value":"Core workflows","id":"core-workflows","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"seo":{"title":"Caraer CLI"}},"lastModified":"2026-08-23T14:27:46.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/apis/cli","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}