@kortyx/cli 0.1.4 → 0.2.0

package/CHANGELOG.md

@@ -1,5 +1,33 @@
 # Changelog
 
+## [0.2.0](https://github.com/kortyx-io/kortyx/compare/cli-v0.1.5...cli-v0.2.0) (2026-08-02)
+
+
+### Features
+
+* **cli:** add local Studio lifecycle ([6de8d4a](https://github.com/kortyx-io/kortyx/commit/6de8d4a438e12bb12648e26d7bf92cf3bd6ea987))
+* **cli:** add Studio OSS lifecycle commands ([aa3e474](https://github.com/kortyx-io/kortyx/commit/aa3e474ae134ed5ccff77021193553828a941f85))
+* **release:** add multi-architecture Studio pipeline ([f2d05b0](https://github.com/kortyx-io/kortyx/commit/f2d05b0550b7132bd51e7b3282a34e01f2b64ec7))
+* **studio:** harden self-hosted preview ([c5438f8](https://github.com/kortyx-io/kortyx/commit/c5438f89499f98df7bf6d10cff9e1e37812a1496))
+* **studio:** release self-hosted observability preview ([4e9d3fd](https://github.com/kortyx-io/kortyx/commit/4e9d3fdbc7233f9b1de94ca1afe6dbae9cc9157f))
+* **studio:** release self-hosted observability preview ([#139](https://github.com/kortyx-io/kortyx/issues/139)) ([4e9d3fd](https://github.com/kortyx-io/kortyx/commit/4e9d3fdbc7233f9b1de94ca1afe6dbae9cc9157f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @kortyx/agent bumped to 0.15.0
+    * @kortyx/telemetry-contracts bumped to 0.2.0
+
+## [0.1.5](https://github.com/kortyx-io/kortyx/compare/cli-v0.1.4...cli-v0.1.5) (2026-02-17)
+
+
+### Bug Fixes
+
+* **release:** publish packages with pnpm and public access ([357e268](https://github.com/kortyx-io/kortyx/commit/357e2680469e729ea58d103915989142f668a39a))
+* **release:** publish packages with pnpm and public access ([5ef7498](https://github.com/kortyx-io/kortyx/commit/5ef7498330129f376ca7197b70cb7b6a38138e8a))
+
 ## [0.1.4](https://github.com/kortyx-io/kortyx/compare/cli-v0.1.3...cli-v0.1.4) (2026-02-17)
 
 

package/LICENSE

@@ -0,0 +1,209 @@
+Copyright 2026 Kortyx contributors
+
+Portions of this software are licensed as follows:
+
+- All content that resides under the `apps/studio/` directory of this repository is licensed under the license defined in `apps/studio/LICENSE.md`.
+- All content that resides under a `plugins/*/` directory of this repository is licensed under the license defined in that plugin's `LICENSE.md`.
+- All third party components incorporated into the Kortyx software are licensed under the original license provided by the owner of the applicable component.
+- Content outside of the above mentioned directories or restrictions is available under the Apache License, Version 2.0, as defined below.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+  TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+  1.  Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+  2.  Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+  3.  Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+  4.  Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+      Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+      stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+      that You distribute, all copyright, patent, trademark, and
+      attribution notices from the Source form of the Work,
+      excluding those notices that do not pertain to any part of
+      the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+      distribution, then any Derivative Works that You distribute must
+      include a readable copy of the attribution notices contained
+      within such NOTICE file, excluding those notices that do not
+      pertain to any part of the Derivative Works, in at least one
+      of the following places: within a NOTICE text file distributed
+      as part of the Derivative Works; within the Source form or
+      documentation, if provided along with the Derivative Works; or,
+      within a display generated by the Derivative Works, if and
+      wherever such third-party notices normally appear. The contents
+      of the NOTICE file are for informational purposes only and
+      do not modify the License. You may add Your own attribution
+      notices within Derivative Works that You distribute, alongside
+      or as an addendum to the NOTICE text from the Work, provided
+      that such additional attribution notices cannot be construed
+      as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+  5.  Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+  6.  Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+  7.  Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+  8.  Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+  9.  Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+  END OF TERMS AND CONDITIONS
+
+  APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+  Copyright [yyyy] [name of copyright owner]
+
+  Licensed under the Apache License, Version 2.0 (the "License");
+  you may not use this file except in compliance with the License.
+  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing, software
+  distributed under the License is distributed on an "AS IS" BASIS,
+  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+  See the License for the specific language governing permissions and
+  limitations under the License.

package/README.md

@@ -1,13 +1,169 @@
 # @kortyx/cli
 
-CLI tooling for Kortyx (work in progress).
+[![npm version](https://img.shields.io/npm/v/@kortyx/cli.svg)](https://www.npmjs.com/package/@kortyx/cli)
+[![CI](https://github.com/kortyx-io/kortyx/actions/workflows/ci.yml/badge.svg)](https://github.com/kortyx-io/kortyx/actions/workflows/ci.yml)
+[![License](https://img.shields.io/npm/l/@kortyx/cli.svg)](https://github.com/kortyx-io/kortyx/blob/main/LICENSE)
+
+CLI tooling entrypoint for Kortyx projects.
+
+The main production API surface is the `kortyx` package; this package is for project automation and developer workflow commands.
+
+The CLI is Apache-2.0. The Studio UI it manages is source-available under
+Elastic License 2.0; see the
+[self-hosted preview guide](https://github.com/kortyx-io/kortyx/blob/main/docs/studio/self-hosted-preview.md).
+
+## Start Kortyx Studio locally
+
+From any project that uses the `kortyx` SDK:
+
+```bash
+npx kortyx studio start
+```
+
+The command checks Docker, creates private local configuration under
+`~/.kortyx/studio`, pulls the published API and Studio images, migrates and
+bootstraps Postgres, and waits for the complete stack to become healthy. It
+then prints:
+
+- the Studio URL and generated local sign-in
+- the telemetry API URL and project-scoped SDK key
+- the exact environment variables to add to the server side of your app
+
+Credentials and database data survive stop, restart, CLI upgrades, and
+repeated `start` calls.
+
+Published Studio images support `linux/amd64` and `linux/arm64`. This covers
+standard Linux hosts, Apple Silicon Docker Desktop, and ARM64 Linux. Docker
+selects the correct image automatically. Windows containers and other
+architectures are not release-tested.
+
+```bash
+npx kortyx studio status
+npx kortyx studio logs
+npx kortyx studio credentials
+npx kortyx studio restart
+npx kortyx studio stop
+```
+
+To choose different host ports or pin a published Studio release:
+
+```bash
+npx kortyx studio start \
+  --studio-port 7300 \
+  --api-port 7400 \
+  --image-tag v0.1.0
+```
+
+Reset is intentionally explicit because it deletes the local Studio database:
+
+```bash
+npx kortyx studio reset --confirm
+```
+
+### Connect an existing SDK project
+
+Copy the values printed by `studio start` or `studio credentials` to a
+server-only `.env.local`:
+
+```bash
+KORTYX_TELEMETRY_API_URL=http://localhost:6400
+KORTYX_TELEMETRY_API_KEY=ktyx_live_...
+KORTYX_TELEMETRY_ENVIRONMENT=development
+KORTYX_TELEMETRY_SERVICE_NAME=my-agent
+```
+
+Install the optional HTTP telemetry adapter if the project does not already
+use it:
+
+```bash
+pnpm add @kortyx/telemetry
+```
+
+Create the optional telemetry adapter once and attach it to your agent:
+
+```ts
+import { createKortyxTelemetryAdapter } from "@kortyx/telemetry";
+
+const telemetry = createKortyxTelemetryAdapter({
+  endpoint: process.env.KORTYX_TELEMETRY_API_URL!,
+  apiKey: process.env.KORTYX_TELEMETRY_API_KEY!,
+  environment: process.env.KORTYX_TELEMETRY_ENVIRONMENT ?? "development",
+  service: {
+    name: process.env.KORTYX_TELEMETRY_SERVICE_NAME ?? "my-agent",
+  },
+});
+```
+
+Telemetry configuration and secrets belong on the server. Do not expose the
+telemetry key in browser bundles or public environment variables.
+
+The CLI keeps local Docker lifecycle separate from future Studio administration
+commands. Remote management commands will call a Studio Admin API and will
+never manipulate the Studio database directly. See the
+[CLI architecture](https://github.com/kortyx-io/kortyx/blob/main/docs/design-specs/kortyx-cli-architecture.md).
+
+## Push workflow topology to Studio
+
+Kortyx Studio should receive workflow topology as a build/deploy artifact, not only as best-effort runtime telemetry. Use `topology push` in local dev, release CI, or deployment pipelines:
+
+```bash
+kortyx topology push --entry src/lib/agent.ts
+```
+
+The entry module can export:
+
+- `agent` from `createAgent(...)`
+- `default` as an agent
+- `workflows` as a workflow definition array
+- named workflow definitions
+
+Options:
+
+```bash
+kortyx topology push \
+  --entry src/lib/agent.ts \
+  --api-url "$KORTYX_TELEMETRY_API_URL" \
+  --api-key "$KORTYX_TELEMETRY_API_KEY" \
+  --environment production \
+  --service-name my-app \
+  --deployment-ref "$GITHUB_SHA"
+```
+
+Environment defaults:
+
+- `KORTYX_TELEMETRY_API_URL` or `KORTYX_API_URL`
+- `KORTYX_TELEMETRY_API_KEY`
+- `KORTYX_TELEMETRY_ENVIRONMENT` or `NODE_ENV` or `development`
+- `KORTYX_TELEMETRY_SERVICE_NAME` or nearest `package.json` name
+- `KORTYX_TELEMETRY_DEPLOYMENT_REF`, `GITHUB_SHA`, or `VERCEL_GIT_COMMIT_SHA`
+
+Check what will be sent without writing to Studio:
+
+```bash
+kortyx topology push --entry src/lib/agent.ts --dry-run
+```
+
+The API owns topology versioning. The CLI sends deterministic topology snapshots; the API creates a new workflow revision only when the topology hash changes.
 
 ## Install
 
+Projects using `kortyx` already have the `kortyx` binary available. To install
+the automation package independently:
+
+```bash
+pnpm add -D @kortyx/cli
+```
+
 ```bash
 npm install -g @kortyx/cli
 ```
 
+## Documentation
+
+- [Documentation](https://kortyx.io/docs)
+- [Main package README](https://github.com/kortyx-io/kortyx/tree/main/packages/kortyx)
+- [Monorepo](https://github.com/kortyx-io/kortyx)
+
 ## License
 
-Apache-2.0
+Apache-2.0. See [LICENSE](https://github.com/kortyx-io/kortyx/blob/main/LICENSE).

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }