{"id":15372932,"url":"https://github.com/smaeda-ks/orb-hashicorp-vault-cli","last_synced_at":"2026-02-02T03:36:14.186Z","repository":{"id":40372947,"uuid":"476139338","full_name":"smaeda-ks/orb-hashicorp-vault-cli","owner":"smaeda-ks","description":"A handy CircleCI Orb that helps you to integrate HashiCorp Vault with your CI/CD pipelines by leveraging the CircleCI OIDC support.","archived":false,"fork":false,"pushed_at":"2022-05-30T14:12:44.000Z","size":32,"stargazers_count":2,"open_issues_count":0,"forks_count":5,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-12-22T16:53:34.244Z","etag":null,"topics":["circleci","hashicorp-vault","oidc","vault"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/smaeda-ks.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-03-31T03:40:34.000Z","updated_at":"2024-01-18T01:42:15.000Z","dependencies_parsed_at":"2022-08-09T18:42:16.939Z","dependency_job_id":null,"html_url":"https://github.com/smaeda-ks/orb-hashicorp-vault-cli","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smaeda-ks%2Forb-hashicorp-vault-cli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smaeda-ks%2Forb-hashicorp-vault-cli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smaeda-ks%2Forb-hashicorp-vault-cli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/smaeda-ks%2Forb-hashicorp-vault-cli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/smaeda-ks","download_url":"https://codeload.github.com/smaeda-ks/orb-hashicorp-vault-cli/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239449584,"owners_count":19640535,"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":["circleci","hashicorp-vault","oidc","vault"],"created_at":"2024-10-01T13:53:43.050Z","updated_at":"2026-02-02T03:36:13.805Z","avatar_url":"https://github.com/smaeda-ks.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# orb-hashicorp-vault-cli\n\n[![CircleCI Build Status](https://circleci.com/gh/smaeda-ks/orb-hashicorp-vault-cli.svg?style=shield \"CircleCI Build Status\")](https://circleci.com/gh/smaeda-ks/orb-hashicorp-vault-cli) [![CircleCI Orb Version](https://badges.circleci.com/orbs/smaeda-ks/orb-hashicorp-vault-cli.svg)](https://circleci.com/orbs/registry/orb/smaeda-ks/orb-hashicorp-vault-cli) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/smaeda-ks/orb-hashicorp-vault-cli/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)\n\n\nA custom CircleCI Orb for HashiCorp Vault CLI.\n\nThis Orb provides a few [commands](https://circleci.com/docs/2.0/orb-concepts/#commands) as below:\n\n| Command | Description | Documentation |\n| ---| --- | --- |\n| `install`   | Install Vault binary to the current executor environment. | [link](https://circleci.com/developer/orbs/orb/smaeda-ks/orb-hashicorp-vault-cli#commands-install) |\n| `auth-oidc` | Authenticate with Vault using OIDC and obtain a token. Upon successful authentication, the obtained token will be set to the `VAULT_TOKEN` environment variable using `$BASH_ENV`. | [link](https://circleci.com/developer/orbs/orb/smaeda-ks/orb-hashicorp-vault-cli#commands-auth-oidc) |\n| `revoke-self`   | Revoke the token set to the `VAULT_TOKEN` environment variable against the Vault instance set to the `VAULT_ADDR` environment variable. | [link](https://circleci.com/developer/orbs/orb/smaeda-ks/orb-hashicorp-vault-cli#commands-revoke-self) |\n\n## Example Orb usage\n\n```yaml\ndescription: |\n  Install Vault binary, authenticate using OIDC, and get secrets.\nusage:\n  version: 2.1\n  orbs:\n    orb-hashicorp-vault-cli: smaeda-ks/orb-hashicorp-vault-cli@0.1.2\n  jobs:\n    my-job:\n      machine: true\n      steps:\n        - checkout\n        # Install Vault\n        - orb-hashicorp-vault-cli/install\n        # Authenticate using OIDC and obtain token\n        # This will automatically set VAULT_TOKEN env variable\n        - orb-hashicorp-vault-cli/auth-oidc:\n            vault-address: \"http://localhost:8200\"\n            vault-role: \"circleci-dev\"\n        - run:\n            name: Get secret\n            command: |\n              # export secret using $BASH_ENV\n              # so it can be referenced by subsequent steps within the job\n              FOO=$(vault kv get -field=password secret/circleci/dev)\n              echo \"export SECRET_FOO=${FOO}\" \u003e\u003e $BASH_ENV\n        # Revoke Vault token after finishing all steps\n        - orb-hashicorp-vault-cli/revoke-self\n  workflows:\n    use-my-orb:\n      jobs:\n        - my-job:\n            # You must use context for jobs require OIDC\n            context: my-context\n```\n\n## Example Vault configuration\n\nAn example Vault configuration can be found in this repository's `.circleci` folder:\n\nhttps://github.com/smaeda-ks/orb-hashicorp-vault-cli/blob/main/.circleci\n\n## Resources\n\n[CircleCI Orb Registry Page](https://circleci.com/orbs/registry/orb/smaeda-ks/orb-hashicorp-vault-cli) - The official registry page of this orb for all versions, executors, commands, and jobs described.\n[CircleCI Orb Docs](https://circleci.com/docs/2.0/orb-intro/#section=configuration) - Docs for using and creating CircleCI Orbs.\n\n### How to Contribute\n\nWe welcome [issues](https://github.com/smaeda-ks/orb-hashicorp-vault-cli/issues) to and [pull requests](https://github.com/smaeda-ks/orb-hashicorp-vault-cli/pulls) against this repository!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmaeda-ks%2Forb-hashicorp-vault-cli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsmaeda-ks%2Forb-hashicorp-vault-cli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsmaeda-ks%2Forb-hashicorp-vault-cli/lists"}