Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix readme formatting #89

Merged
merged 1 commit into from
Sep 13, 2023
Merged

fix readme formatting #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 23 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# opc - A CLI for OpenShift Pipeline

`opc` make it easy to work with Tekton resources in OpenShift Pipelines. It is built on top of `tkn` and `tkn-pac` and expands their capablities to the functionality and user-experience that is available on OpenShift.
`opc` make it easy to work with Tekton resources in OpenShift Pipelines. It is
built on top of `tkn` and `tkn-pac` and expands their capablities to the
functionality and user-experience that is available on OpenShift.

## Build

Expand All @@ -14,45 +16,44 @@ i.e:

The following commands help you understand and effectively use the OpenShift Pipelines CLI:

`opc hub`: search and install from Tekton Hub

`opc pac`: add and manage git repositories (pipelines as code)

`opc results` : interact with results api

`opc pipeline`: manage Pipelines
`opc pipelinerun`: manage PipelineRuns
`opc task`: manage Tasks
`opc clustertask`: manage ClusterTasks
`opc taskrun`: manage TaskRuns

`opc triggerbinding`: manage TriggerBindings
`opc clustertriggerbinding`: manage ClusterTriggerBindings
`opc triggertemplate`: manage TriggerTemplates
`opc eventlistener`: manage EventListeners
- `opc hub`: search and install from Tekton Hub
- `opc pac`: add and manage git repositories (pipelines as code)
- `opc results` : interact with results api
- `opc clustertask`: manage ClusterTasks
- `opc pipeline`: manage Pipelines
- `opc pipelinerun`: manage PipelineRuns
- `opc task`: manage Tasks
- `opc taskrun`: manage TaskRuns
- `opc clustertriggerbinding`: manage ClusterTriggerBindings
- `opc eventlistener`: manage EventListeners
- `opc triggerbinding`: manage TriggerBindings
- `opc triggertemplate`: manage TriggerTemplates

## Features

### Versions :
### Versions

- `opc version`: Show all versions of all components
- `opc version [pac|tkn|opc]` show version of a specific component

### Completion :
### Completion

`opc completions [bash|zsh|...]`

### Plugins :
### Plugins

tkn plugins are used for opc plugins (ie: [tkn-watch](https://github.com/chmouel/tkn-watch/) become opc watch), it doesn't try to show any opc plugins. (may change).
tkn plugins are used for opc plugins (ie:
[tkn-watch](https://github.com/chmouel/tkn-watch/) become opc watch), it
doesn't try to show any opc plugins. (may change).

## Install

### Release

## Release download

Go to the [release](https://github.com/openshift-pipelines/opc/releases) page and choose your archive or package for your platform.
Go to the [release](https://github.com/openshift-pipelines/opc/releases) page
and choose your archive or package for your platform.

## Homebrew

Expand Down Expand Up @@ -81,6 +82,3 @@ Checkout the directory and use :
-$ make
-$ ./bin/opc --help
```