@apicircle/cli 1.0.0

package/LICENSE

@@ -0,0 +1,110 @@
+APICircle Studio License
+Custom Source-Available License, v1.0
+
+Copyright (c) 2026 Deva Prakash ("Licensor")
+
+The source code in this repository ("the Software") is made available for
+the purposes of transparency, security review, contribution, and personal
+evaluation. This is NOT an open-source license as defined by the Open
+Source Initiative.
+
+0. Definitions
+
+   "Commercial Use" means any use of the Software that is intended for
+   or directed toward commercial advantage or monetary compensation,
+   whether direct or indirect, including without limitation:
+
+   (a) using the Software to build, test, develop, deploy, or operate
+       any product, service, application, or system that is sold,
+       licensed, hosted, distributed, or otherwise made available to
+       any third party for a fee or other consideration;
+   (b) using the Software in the course of paid employment, paid
+       consulting, paid contracting, freelance work, or any other
+       revenue-generating activity, regardless of whether the Software
+       itself is sold or transferred;
+   (c) using the Software internally within a for-profit organization
+       beyond the Evaluation Period defined below;
+   (d) integrating the Software, or any portion of it, into any tool,
+       pipeline, automation, or workflow that supports the commercial
+       operations of any business;
+   (e) using the Software to provide a hosted, managed, or embedded
+       service of any kind to a third party, whether free or paid.
+
+   "Non-Commercial Use" means any use that is not Commercial Use,
+   including personal hobby projects, individual learning, academic
+   research, classroom instruction, and good-faith contribution to
+   this repository.
+
+   "Evaluation Period" means a single, continuous period of up to
+   thirty (30) days during which a for-profit organization may
+   internally evaluate the Software at no charge. After the Evaluation
+   Period expires, any further use of the Software by that organization
+   constitutes Commercial Use and requires a separate commercial
+   license from the Licensor.
+
+1. Permitted Use
+
+   You may, without charge:
+
+   (a) view, read, and study the source code of the Software;
+   (b) run the Software, in source or compiled form, for your own
+       Non-Commercial Use, or for Commercial Use solely within the
+       Evaluation Period;
+   (c) submit improvements to the Software back to this repository via
+       pull request, subject to Section 3 (Contributions).
+
+2. Prohibited Use
+
+   Without prior written permission from the Licensor, you may NOT:
+
+   (a) make any Commercial Use of the Software, in whole or in part,
+       except during the Evaluation Period as defined in Section 0;
+   (b) redistribute the Software, in source or compiled form, whether
+       modified or unmodified, to any third party;
+   (c) sublicense, sell, rent, lease, or otherwise transfer the
+       Software or any rights granted herein;
+   (d) remove, obscure, or alter any copyright, trademark, attribution,
+       or license notice contained in the Software;
+   (e) use the names "APICircle", "API Circle Studio", or any related
+       logos or trademarks, except as required for accurate attribution.
+
+3. Contributions
+
+   By submitting any contribution (including but not limited to code,
+   documentation, or assets) to this repository, you grant the Licensor
+   a perpetual, worldwide, irrevocable, royalty-free, sublicensable
+   license to use, modify, distribute, and relicense your contribution
+   under any terms, including the terms of this license or any future
+   version thereof.
+
+4. No Trademark License
+
+   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 Software.
+
+5. Termination
+
+   The rights granted in Section 1 terminate automatically if you
+   breach any term of this license. Upon termination, you must cease
+   all use of the Software and destroy all copies in your possession.
+
+6. Disclaimer of Warranty
+
+   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+   EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+   MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, TITLE, AND
+   NON-INFRINGEMENT.
+
+7. Limitation of Liability
+
+   IN NO EVENT SHALL THE LICENSOR BE LIABLE FOR ANY CLAIM, DAMAGES, OR
+   OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT, OR
+   OTHERWISE, ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE
+   OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+8. Commercial Licensing
+
+   For commercial licensing, redistribution, or any use not permitted
+   under Section 1, contact: apicircle365@gmail.com

package/README.md

@@ -0,0 +1,72 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/apicircle/studio/main/assets/logo.png" alt="APICircle Studio" width="120" height="120" />
+</p>
+
+<h1 align="center">@apicircle/cli</h1>
+
+Command-line companion to [APICircle Studio](https://github.com/apicircle/studio). Run mock servers, drive the MCP server, import OpenAPI / Postman / Insomnia / curl into a workspace, and execute saved plans — all from any terminal, no Electron required.
+
+## Install
+
+```bash
+npm install -g @apicircle/cli
+# or use without installing
+npx @apicircle/cli --help
+```
+
+## Subcommands
+
+### `apicircle mock <spec>`
+
+Boot a mock server from an OpenAPI / Postman / Insomnia file.
+
+```bash
+apicircle mock ./openapi.yaml --port 4040
+apicircle mock ./postman_collection.json --type postman
+apicircle mock ./insomnia_export.json --type insomnia --cors=false
+```
+
+The CLI binds to a free port unless `--port` is set, prints the URL, and runs until you `Ctrl-C`.
+
+### `apicircle mcp [--workspace <dir>]`
+
+Start the MCP stdio server pointed at a workspace folder.
+
+```bash
+apicircle mcp --workspace ./my-workspace
+APICIRCLE_WORKSPACE=./my-workspace apicircle mcp
+```
+
+If `--workspace` is omitted, the current directory is used. The directory is auto-initialized with an empty `workspace.synced.json` + `workspace.local.json` on first run.
+
+Wire this into Claude Desktop / Cursor / etc — see [Connect your AI client](https://github.com/apicircle/studio/blob/main/docs/connect-your-ai-client.md).
+
+### `apicircle import <type> <input>`
+
+Import a spec into a workspace folder.
+
+```bash
+apicircle import openapi  ./spec.yaml --workspace ./ws --format yaml
+apicircle import postman  ./col.json  --workspace ./ws
+apicircle import insomnia ./exp.json  --workspace ./ws
+apicircle import curl     ./curl.txt  --workspace ./ws
+apicircle import openapi  -           --workspace ./ws < ./spec.yaml
+```
+
+Each import appends one request per operation/item to `workspace.synced.json`.
+
+### `apicircle run <plan>`
+
+Execute a saved workspace execution plan headlessly and report pass/fail.
+
+```bash
+apicircle run "Smoke Tests" --reporter junit
+apicircle run plan_a1b2c3 --env staging --bail
+apicircle run "Nightly" --secrets ./secrets.json --no-save
+```
+
+Resolves a plan by name or id, runs each step through the real request engine, evaluates assertions, and carries extracted context forward. Flags: `--reporter text|json|junit`, `--bail` (stop at the first failed step), `--env <name>` (layer an environment onto the run), `--secrets <file>` or `APICIRCLE_SECRET_*` env vars (encrypted variables), `--no-save`, `--no-assertions`. Exit codes: `0` pass, `1` fail, `2` usage error, `3` run denied.
+
+## License
+
+Released under the **APICircle Studio License** — a custom source-available license, not an OSI-approved open-source license. Free for personal, educational, and non-commercial use, plus a 30-day commercial evaluation period; ongoing commercial use requires a separate license. See [LICENSE](./LICENSE) for the full terms, or contact **apicircle365@gmail.com** for commercial licensing.