{"_id":"@apiary-gateway/cli","_rev":"8-0e88061a3596b1e4a8cf5d799b6f737e","name":"@apiary-gateway/cli","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.0":{"name":"@apiary-gateway/cli","version":"1.0.0","keywords":[],"author":"","license":"ISC","_id":"@apiary-gateway/cli@1.0.0","maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"}],"bin":{"apiary":"dist/bin/index.js"},"dist":{"shasum":"c69b6320da9f969c0e7b9648fd50dbdc56252409","tarball":"https://registry.npmjs.org/@apiary-gateway/cli/-/cli-1.0.0.tgz","fileCount":44,"integrity":"sha512-Ufb+ZnNZbfM8sUgCrY4QzC/X2+nFIG1oMkE9rW0wmE/SCVkvxJZ26mUnFRWTxwffUEo5b9goH9dGi41Q9TdAmw==","signatures":[{"sig":"MEUCIQDgv5JT7tmFXsf6asLU/UolQydLvbbwcNuEwmBMhq0qFgIgBfkYTOxVxR8+/CLvXiFyjujLrChFs1lO2c3O56fod2w=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":32014},"main":"dist/bin/index.js","types":"dist/bin/index.d.ts","gitHead":"14fa68c1ac4e1f28c8682238c86a37439a59c7f7","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"ts-node bin/index.ts"},"_npmUser":{"name":"phonzay1","email":"phonzay1@gmail.com"},"_npmVersion":"9.2.0","description":"CLI for managing Apiary LLM Gateway","directories":{},"_nodeVersion":"18.19.1","dependencies":{"inquirer":"^12.5.2","commander":"^13.1.0","@aws-sdk/client-api-gateway":"^3.782.0","@aws-sdk/client-bedrock-runtime":"^3.785.0","@aws-sdk/client-secrets-manager":"^3.782.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.0_1745435231679_0.37852855452454115","host":"s3://npm-registry-packages-npm-production"}},"1.0.1":{"name":"@apiary-gateway/cli","version":"1.0.1","keywords":[],"author":"","license":"ISC","_id":"@apiary-gateway/cli@1.0.1","maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"}],"bin":{"apiary":"dist/bin/index.js"},"dist":{"shasum":"725df8f25a6b8dcf629f4b004a8a6e73c59ff8b4","tarball":"https://registry.npmjs.org/@apiary-gateway/cli/-/cli-1.0.1.tgz","fileCount":44,"integrity":"sha512-7jder9LdezY9bBJ4Z3NW7PqT92rkexBCjpi5XJFVedLpsBd9toY63ZTxiZc8J65OGDNgFwruKaMxXz3imqg0Hw==","signatures":[{"sig":"MEQCIDMHrstD/KymTDpXXrq+Gxg7cJxHIcPGeDVGVAs2hDs6AiAL4BJhMEOwTOHeOVNG4WLmrI9qjSAAx5xBvaNlG4MI9Q==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":32849},"main":"dist/bin/index.js","types":"dist/bin/index.d.ts","gitHead":"14fa68c1ac4e1f28c8682238c86a37439a59c7f7","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"ts-node bin/index.ts"},"_npmUser":{"name":"phonzay1","email":"phonzay1@gmail.com"},"_npmVersion":"9.2.0","description":"CLI for managing Apiary LLM Gateway","directories":{},"_nodeVersion":"18.19.1","dependencies":{"inquirer":"^12.5.2","commander":"^13.1.0","@aws-sdk/client-api-gateway":"^3.782.0","@aws-sdk/client-bedrock-runtime":"^3.785.0","@aws-sdk/client-secrets-manager":"^3.782.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.1_1745436597378_0.9092872098706197","host":"s3://npm-registry-packages-npm-production"}},"1.0.2":{"name":"@apiary-gateway/cli","version":"1.0.2","keywords":[],"author":"","license":"ISC","_id":"@apiary-gateway/cli@1.0.2","maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"},{"name":"kjpoccia","email":"kjpoccia@gmail.com"}],"bin":{"apiary":"dist/bin/index.js"},"dist":{"shasum":"4b510a1da5f164da6f893da9945c591dc137e846","tarball":"https://registry.npmjs.org/@apiary-gateway/cli/-/cli-1.0.2.tgz","fileCount":44,"integrity":"sha512-OR9szi+hRhenACmJPlhL2JNGD+u61zypHLFYWnZ6KKd/vLmmKBh0feXGXtFtuaRaGT4g5KHGQcobzztkE/mIqg==","signatures":[{"sig":"MEUCIQC2gI6COwuA+Za3/tIGDFMBc6+AkPgjoGCog1OlDEMPbAIgdg9d8IVl7n4Dloh6C1wGVTukDHcyjEmw/d/jP1kmiSE=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":32814},"main":"dist/bin/index.js","types":"dist/bin/index.d.ts","gitHead":"cd94d6784b78363f5fe02b4f610e225cb3cb68df","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"ts-node bin/index.ts"},"_npmUser":{"name":"phonzay1","email":"phonzay1@gmail.com"},"_npmVersion":"9.2.0","description":"CLI for managing Apiary LLM Gateway","directories":{},"_nodeVersion":"18.19.1","dependencies":{"inquirer":"^12.5.2","commander":"^13.1.0","@aws-sdk/client-api-gateway":"^3.782.0","@aws-sdk/client-bedrock-runtime":"^3.785.0","@aws-sdk/client-secrets-manager":"^3.782.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.2_1745518114688_0.37804989134924627","host":"s3://npm-registry-packages-npm-production"}},"1.0.3":{"name":"@apiary-gateway/cli","version":"1.0.3","keywords":[],"author":"","license":"ISC","_id":"@apiary-gateway/cli@1.0.3","maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"},{"name":"kjpoccia","email":"kjpoccia@gmail.com"}],"bin":{"apiary":"dist/bin/index.js"},"dist":{"shasum":"7c05cc25532f6fffb2675f1bf79a20a701a0d1cd","tarball":"https://registry.npmjs.org/@apiary-gateway/cli/-/cli-1.0.3.tgz","fileCount":44,"integrity":"sha512-HDITxbmNU4OpR/FvZjzTJDQ6+W0qDF2Wv8dC3bvLEFTrZfEh9ssDgfocZOE1IZOnQ8uxhvTSFYGiHbYeXImKqw==","signatures":[{"sig":"MEQCIHjj1nWySNzzV7pHeOiwNxhhW5XmGS2PaYUoaCtKPEpsAiBiRe+kBnW9qmv1/UOkjugn1ph0nhq20tFpJshW4NX9WQ==","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":34444},"main":"dist/bin/index.js","types":"dist/bin/index.d.ts","gitHead":"c3164e89d9b1a1c0273fd5ebe8a263930c65db36","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"ts-node bin/index.ts"},"_npmUser":{"name":"phonzay1","email":"phonzay1@gmail.com"},"_npmVersion":"9.2.0","description":"CLI for managing the Apiary LLM Gateway","directories":{},"_nodeVersion":"18.19.1","dependencies":{"inquirer":"^12.5.2","commander":"^13.1.0","@aws-sdk/client-api-gateway":"^3.782.0","@aws-sdk/client-bedrock-runtime":"^3.785.0","@aws-sdk/client-secrets-manager":"^3.782.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.3_1746038123948_0.8657429473259459","host":"s3://npm-registry-packages-npm-production"}},"1.0.4":{"name":"@apiary-gateway/cli","version":"1.0.4","keywords":[],"author":"","license":"ISC","_id":"@apiary-gateway/cli@1.0.4","maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"},{"name":"kjpoccia","email":"kjpoccia@gmail.com"}],"bin":{"apiary":"dist/bin/index.js"},"dist":{"shasum":"6e02dde86e809f72e7722e7251fb78971595a16e","tarball":"https://registry.npmjs.org/@apiary-gateway/cli/-/cli-1.0.4.tgz","fileCount":44,"integrity":"sha512-Jg2bOUInCfMaBLfLlxXs6vYS3IqwqeM1tyAU7FnhEvU5MsMyDouYTZ5iUPDpgiJJHkGUWcyW9w9fHHUOw+kg0w==","signatures":[{"sig":"MEUCID4qDrW56sfb25OoCdEq1l23oV3N5mcO7BSfKihSzMSEAiEAs2+xgMqWwQaPUseot9IuqW3qyA5AVvE/8u8NBwy7l4k=","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":34444},"main":"dist/bin/index.js","types":"dist/bin/index.d.ts","gitHead":"c3164e89d9b1a1c0273fd5ebe8a263930c65db36","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"ts-node bin/index.ts"},"_npmUser":{"name":"phonzay1","email":"phonzay1@gmail.com"},"_npmVersion":"9.2.0","description":"CLI for managing the Apiary LLM Gateway","directories":{},"_nodeVersion":"18.19.1","dependencies":{"inquirer":"^12.5.2","commander":"^13.1.0","@aws-sdk/client-api-gateway":"^3.782.0","@aws-sdk/client-bedrock-runtime":"^3.785.0","@aws-sdk/client-secrets-manager":"^3.782.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.4_1746039660650_0.8464149494519735","host":"s3://npm-registry-packages-npm-production"}},"1.0.5":{"name":"@apiary-gateway/cli","version":"1.0.5","keywords":[],"author":"","license":"ISC","_id":"@apiary-gateway/cli@1.0.5","maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"},{"name":"kjpoccia","email":"kjpoccia@gmail.com"}],"bin":{"apiary":"dist/bin/index.js"},"dist":{"shasum":"c9c75e2690a02cbdcd904ce0337f5ae450786104","tarball":"https://registry.npmjs.org/@apiary-gateway/cli/-/cli-1.0.5.tgz","fileCount":44,"integrity":"sha512-w1011z9qedyPs6QKYSTbQN6qK4Sw6xGC4rgkXqPG0sZ/xQLAaEkClGCxBrGiGG5JXCu0mXT9ctkZpx/G3cZnhw==","signatures":[{"sig":"MEYCIQDpT+TWvU2iD7aNmHcQw4SBV6bJpUrZLilIgZbjKnCmvAIhAP89CLV0N2cR6hVJ/dCEOcbeen+aYWXeRsemPyCxJakO","keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U"}],"unpackedSize":34444},"main":"dist/bin/index.js","types":"dist/bin/index.d.ts","gitHead":"c3164e89d9b1a1c0273fd5ebe8a263930c65db36","scripts":{"test":"echo \"Error: no test specified\" && exit 1","start":"ts-node bin/index.ts"},"_npmUser":{"name":"phonzay1","email":"phonzay1@gmail.com"},"_npmVersion":"9.2.0","description":"CLI for managing the Apiary LLM Gateway","directories":{},"_nodeVersion":"18.19.1","dependencies":{"inquirer":"^12.5.2","commander":"^13.1.0","@aws-sdk/client-api-gateway":"^3.782.0","@aws-sdk/client-bedrock-runtime":"^3.785.0","@aws-sdk/client-secrets-manager":"^3.782.0"},"_hasShrinkwrap":false,"devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3"},"_npmOperationalInternal":{"tmp":"tmp/cli_1.0.5_1746040797516_0.32651188631582806","host":"s3://npm-registry-packages-npm-production"}},"1.0.6":{"name":"@apiary-gateway/cli","version":"1.0.6","description":"CLI for managing the Apiary LLM Gateway","main":"dist/bin/index.js","types":"dist/bin/index.d.ts","bin":{"apiary":"dist/bin/index.js"},"scripts":{"start":"ts-node bin/index.ts","test":"echo \"Error: no test specified\" && exit 1"},"keywords":[],"author":"","license":"ISC","devDependencies":{"ts-node":"^10.9.2","typescript":"^5.8.3"},"dependencies":{"@aws-sdk/client-api-gateway":"^3.782.0","@aws-sdk/client-bedrock-runtime":"^3.785.0","@aws-sdk/client-secrets-manager":"^3.782.0","commander":"^13.1.0","inquirer":"^12.5.2"},"gitHead":"c3164e89d9b1a1c0273fd5ebe8a263930c65db36","_id":"@apiary-gateway/cli@1.0.6","_nodeVersion":"18.19.1","_npmVersion":"9.2.0","dist":{"integrity":"sha512-6S8nM9xitk2kln+wHMue5ZU4Eiy1wR2AMoph1crXEqcbvcGnTRs3C0gBgkG71zYk2btW/nSWXs3WzpOCc57t3Q==","shasum":"32cbb6623674f9f91ffe81a89ffc8de75cc4ce16","tarball":"https://registry.npmjs.org/@apiary-gateway/cli/-/cli-1.0.6.tgz","fileCount":44,"unpackedSize":34533,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHzTEvMbvSxZE7BILAAIe6rrezyhmZ5B9dDRNXiRhJr6AiA5LtnKc/dO5Z+iShLibMya/HmCL9Kwhi+EPflkUJmpHw=="}]},"_npmUser":{"name":"phonzay1","email":"phonzay1@gmail.com"},"directories":{},"maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"},{"name":"kjpoccia","email":"kjpoccia@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/cli_1.0.6_1746041259784_0.07196079082296669"},"_hasShrinkwrap":false}},"time":{"created":"2025-04-23T19:07:11.613Z","modified":"2025-04-30T19:27:40.297Z","1.0.0":"2025-04-23T19:07:11.871Z","1.0.1":"2025-04-23T19:29:57.564Z","1.0.2":"2025-04-24T18:08:34.852Z","1.0.3":"2025-04-30T18:35:24.129Z","1.0.4":"2025-04-30T19:01:00.833Z","1.0.5":"2025-04-30T19:19:57.709Z","1.0.6":"2025-04-30T19:27:40.085Z"},"license":"ISC","keywords":[],"description":"CLI for managing the Apiary LLM Gateway","maintainers":[{"name":"phonzay1","email":"phonzay1@gmail.com"},{"name":"kjpoccia","email":"kjpoccia@gmail.com"}],"readme":"\n# Installing Apiary with the Apiary CLI\n\n## Introduction\n\nApiary is a large language model (LLM) gateway for handling requests to multiple\nLLM providers with a unified API. It provides built-in observability, cost tracking, \nfallbacks, request routing, simple and semantic caching, and output guardrails.\n\nThe Apiary CLI tool facilitates easy deployment of its AWS infrastructure.\nOnce deployed, you can start making LLM requests using the [Apiary SDK](https://github.com/Apiary-gateway/clientSDK).\n\n* [Infrastructure Overview](#infrastructure-overview)\n* [Getting Started](#getting-started)\n* [Commands](#commands)\n\n## Infrastructure Overview\n\nApiary deploys and provisions the following key components in your AWS account:\n<p align=\"center\">\n  <img \n    src=\"./diagrams/full-architecture.png\"\n    alt=\"apiary_infrastructure\"\n  >\n</p>\n\n## Getting Started\n\n### Prerequisites\n\nTo get started with Apiary, ensure that you have the following set up:\n- An active [AWS account](https://aws.amazon.com/account/) with a user or role that has the `AdministratorAccess` policy attached. This user or role must be configured for use with the AWS CLI.\n- AWS CLI is [installed](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) and configured\n- AWS CDK is [installed](https://docs.aws.amazon.com/cdk/v2/guide/getting_started.html)\n- AWS Bedrock is configured in your account to allow access to the **Titan Text Embeddings V2 model**\n  - Bedrock access must be configured through the [Bedrock console](https://console.aws.amazon.com/bedrock/). Follow [these steps](https://docs.aws.amazon.com/bedrock/latest/userguide/model-access-modify.html) to grant access to the Titan Text Embeddings V2 model.\n- [Node.js](https://nodejs.org/en/download) and [npm](https://docs.npmjs.com/cli/v10/commands/npm-install) are installed\n\n### Installation\n\nTo install the Apiary CLI tool, run the following command:\n```bash\nnpm install -g @apiary-gateway/cli\n```\n\nTo verify that the installation was successful, run:\n```bash\napiary --version\n```\nThis will output the installed version number.\n\nTo view a list of available commands, run:\n```bash\napiary --help\n```\n\n### First Time Usage\n\nRunning `apiary create` will clone the Apiary CDK infrastructure into a new `apiary` folder inside your current working directory. Make sure you're in the directory where you want the `apiary` folder to be created before running the command.\n\nUpon running `apiary create`, you'll be prompted to provide your LLM provider API\nkeys as part of the deployment process. These will be securely stored using AWS \nSecrets Manager.\n\nOnce deployed, the Apiary CLI will output:\n- An `AiGatewayRestApiEndpoint` URL - you can start sending LLM requests to this URL using the [Apiary SDK](https://github.com/Apiary-gateway/clientSDK)\n- An API key to use when sending requests to your Apiary instance. Please save this key securely for future reference\n  - You can manage API keys and usage plans for your Apiary instance using the [commands](#commands) below\n- A `FrontendBucketUrl` URL - visit this URL to access the Observability and Management \nDashboard. Use the dashboard to:\n  - Set custom routing rules for your Apiary instance\n  - Configure caching and guardrails settings\n  - Monitor requests and LLM responses flowing through the system\n\n## Commands\n\n- [`apiary create`](#apiary-create)\n- [`apiary destroy`](#apiary-destroy)\n- [`apiary update-llm-api-keys`](#apiary-update-llm-api-keys)\n- [`apiary delete-llm-api-keys`](#apiary-delete-llm-api-keys)\n- [`apiary create-usage-plan-with-key`](#apiary-create-usage-plan-with-key)\n- [`apiary get-usage-plans`](#apiary-get-usage-plans)\n- [`apiary delete-usage-plan`](#apiary-delete-usage-plan)\n- [`apiary edit-usage-plan`](#apiary-edit-usage-plan)\n- [`apiary help [COMMAND]`](#apiary-help-[command])\n\n### `apiary create`\n\nDeploy Apiary infrastructure to AWS.\n\n### `apiary destroy`\n\nDelete all Apiary resources in your AWS account. This action is irreversible.\n\n### `apiary update-llm-api-keys`\n\nUpdate your stored API keys for LLM providers.\n\n### `apiary delete-llm-api-keys`\n\nDelete all of your stored API keys for LLM providers. This action is irreversible.\n\n### `apiary create-usage-plan-with-key`\n\nCreate a new usage plan for your Apiary instance with an associated API key.\n\n### `apiary get-usage-plans`\n\nView all usage plans associated with your Apiary instance.\n\n### `apiary delete-usage-plan`\n\nDelete a specific usage plan associated with your Apiary instance. This will also delete \nthe API key(s) associated with the usage plan. You'll be prompted to provide the usage plan ID.\n\n### `apiary edit-usage-plan`\n\nEdit a specific usage plan associated with your Apiary instance. You'll be \nprompted to provide the usage plan ID.\n\n### `apiary help [COMMAND]`\n\nDisplay usage and description for an Apiary command.\n","readmeFilename":"README.md"}