https://github.com/openshift/oc
The OpenShift Command Line, part of OKD
https://github.com/openshift/oc
Last synced: 12 days ago
JSON representation
The OpenShift Command Line, part of OKD
- Host: GitHub
- URL: https://github.com/openshift/oc
- Owner: openshift
- License: apache-2.0
- Created: 2019-05-28T15:42:57.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T19:24:38.000Z (25 days ago)
- Last Synced: 2025-04-04T09:03:32.516Z (19 days ago)
- Language: Go
- Homepage: https://www.openshift.org
- Size: 121 MB
- Stars: 209
- Watchers: 25
- Forks: 398
- Open Issues: 26
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenShift Client - oc
With OpenShift Client CLI (oc), you can create applications and manage OpenShift
resources. It is built on top of [kubectl](https://github.com/kubernetes/kubectl/)
which means it provides its full capabilities to connect with any kubernetes
compliant cluster, and on top adds commands simplifying interaction with an
OpenShift cluster.
# Contributing
All contributions are welcome - oc uses the Apache 2 license and does not require
any contributor agreement to submit patches. Please open issues for any bugs
or problems you encounter, ask questions on the OpenShift IRC channel
(#openshift-dev on freenode), or get involved in the [kubectl](https://github.com/kubernetes/kubectl)
and [kubernetes project](https://github.com/kubernetes/kubernetes) at the container
runtime layer.
## Building
To build oc invoke `make oc`. At any time you can invoke `make help` and you'll
get a list of all supported make sub-commands.
In order to build `oc`, you will need the GSSAPI sources. On a Fedora/CentOS/RHEL
workstation, install them with:
```
dnf install krb5-devel
```
Also:
```
dnf install gpgme-devel
dnf install libassuan-devel
```
For MacOS you'll need to install a few brew packages before building locally. Install them with:
```
brew install heimdal
brew install gpgme
```
## Testing
All PRs will have to pass a series of automated tests starting from go tools
such as `go fmt` and `go vet`, through unit tests, up to e2e against a real cluster.
Locally you can invoke the initial verification and unit test through `make verify`
and `make test`, accordingly.
## Dependencies
Dependencies are managed through [Go Modules](https://github.com/golang/go/wiki/Modules).
When updating any dependency the suggested workflow is:
1. `go mod tidy`
2. `go mod vendor`
# Security Response
If you've found a security issue that you'd like to disclose confidentially
please contact Red Hat's Product Security team. Details at
https://access.redhat.com/security/team/contact
# License
oc is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).