{"id":27081595,"url":"https://github.com/api7/adc","last_synced_at":"2026-02-04T09:30:24.038Z","repository":{"id":193062320,"uuid":"679186619","full_name":"api7/adc","owner":"api7","description":"API Declarative CLI - ADC","archived":false,"fork":false,"pushed_at":"2025-03-26T14:34:54.000Z","size":932,"stargazers_count":39,"open_issues_count":19,"forks_count":6,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-03-26T14:42:35.599Z","etag":null,"topics":["apisix","ci-cd","declaretive","devops","gateway","gitops","iac"],"latest_commit_sha":null,"homepage":"https://docs.api7.ai/enterprise/reference/adc","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/api7.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-08-16T09:33:38.000Z","updated_at":"2025-03-21T13:26:50.000Z","dependencies_parsed_at":"2023-11-29T09:48:06.832Z","dependency_job_id":"8d773dc4-ad6a-48a9-814c-58179ba5ae19","html_url":"https://github.com/api7/adc","commit_stats":null,"previous_names":["api7/adc"],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api7%2Fadc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api7%2Fadc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api7%2Fadc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/api7%2Fadc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/api7","download_url":"https://codeload.github.com/api7/adc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247423921,"owners_count":20936689,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apisix","ci-cd","declaretive","devops","gateway","gitops","iac"],"created_at":"2025-04-06T02:19:54.527Z","updated_at":"2026-02-04T09:30:24.029Z","avatar_url":"https://github.com/api7.png","language":"TypeScript","readme":"# API Declarative CLI (ADC)\n\nADC is a command line utility that interfaces with API7 Enterprise and Apache APISIX Admin APIs.\n\n## Supported Backends\n\nThe following backend types are supported in ADC:\n\n1. [API7 Enterprise](libs/backend-api7/README.md)\n2. [Apache APISIX](libs/backend-apisix/README.md)\n\n## Supported Converters\n\nThe following converters are supported to convert API specifications to ADC configuration:\n\n1. [OpenAPI Spec 3](libs/converter-openapi/README.md)\n\n## Installation\n\nThe easiest way to install ADC is through the install script:\n\n```bash\ncurl -sL \"https://run.api7.ai/adc/install\" | sh\n```\n\nOr, you can download the appropriate binary from the [releases page](https://github.com/api7/adc/releases):\n\nPre-built binaries for `amd64` and `arm64` on Linux, Windows, and macOS are available now.\n\n## Configure ADC\n\nYou can configure ADC through environment variables or command line flags. Run `adc help [command]` to see the available configuration options for a command.\n\nADC supports dotenv, so you can store and use your environment variables in a `.env` file. The examples below show how to configure ADC for both API7 Enterprise and Apache APISIX backends.\n\n### Example API7 Enterprise Configuration\n\n```bash\nADC_BACKEND=api7ee\nADC_SERVER=https://localhost:7443\nADC_TOKEN=\u003ctoken generated from the dashboard\u003e\n```\n\n### Example Apache APISIX Configuration\n\n```bash\nADC_SERVER=http://localhost:9180\nADC_TOKEN=\u003cAPISIX Admin API key\u003e\n```\n\n## Usage\n\nThis section highlights some of the common ADC commands.\n\n### Check Connectivity\n\nThe `ping` command verifies the configuration by trying to connect to the configured backend:\n\n```bash\nadc ping\n```\n\n### Dump Configuration in ADC Format\n\nThe `dump` command fetches the current configuration of the backend and saves it in the ADC configuration file format:\n\n```bash\nadc dump -o adc.yaml\n```\n\n### Show the Difference between Local and Remote Configuration\n\nThe `diff` command compares the configuration in the specified ADC configuration file with the current configuration of the backend:\n\n```bash\nadc diff -f adc.yaml\n```\n\n### Synchronize Local Configuration\n\nThe `sync` command synchronizes the configuration in the specified ADC configuration file with the backend:\n\n```bash\nadc sync -f adc.yaml\n```\n\n### Convert API Specifications\n\nThe `convert` command converts API specifications to ADC configuration. Currently, it supports converting an OpenAPI 3 specification to ADC configuration.\n\n```bash\nadc convert openapi -f openapi.yaml\n```\n\n### Verify ADC Configuration\n\nThe `lint` command verifies the provided ADC configuration file locally.\n\n```bash\nadc lint -f adc.yaml\n```\n\n## Development\n\nTo build ADC from source, [install Nx](https://nx.dev/getting-started/installation) and run:\n\n```bash\npnpm install\nnx build cli\n```\n\nTo use the binary, run:\n\n```bash\nnode dist/apps/cli/main.js -h\n```\n\n## License\n\nThis project is licensed under the [Apache 2.0 License](LICENSE).\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapi7%2Fadc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapi7%2Fadc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapi7%2Fadc/lists"}