## 1. Project Overview & Quickstart (jenkins-x/jx) ## File: README.md # JayeX CLI [](https://pkg.go.dev/mod/github.com/jenkins-x/jx) [](https://goreportcard.com/report/github.com/jenkins-x/jx) [](https://github.com/jenkins-x/jx/releases) [](https://github.com/jenkins-x/jx/blob/master/LICENSE) [](https://slack.k8s.io/) [](https://codecov.io/gh/jenkins-x/jx) `jx` is the modular command line CLI for [JayeX 3.x](https://jayex.io/v3/about/) ## Commands See the [jx command reference](https://jayex.io/v3/develop/reference/jx/) ## Issues To track [issues in this repository](https://github.com/jenkins-x/jx/issues) and all the related [Plugins](#plugins) use these links: * [view open issues in jenkins-x-plugins](https://github.com/issues?q=is%3Aopen+is%3Aissue+author%3Ajstrachan+archived%3Afalse+user%3Ajenkins-x-plugins) * [view open pull requests in jenkins-x-plugins](https://github.com/pulls?q=is%3Aopen+is%3Apr+archived%3Afalse+user%3Ajenkins-x-plugins+-label%3Adependencies) ## Plugins You can browse the documentation for all of the `jx` plugins at: * [Plugin CLI Reference](https://jayex.io/v3/develop/reference/jx/) * [Plugin Source](https://github.com/jenkins-x-plugins) ## Components * [jx-git-operator](https://github.com/jenkins-x/jx-git-operator) is an operator for triggering jobs when git commits are made * [octant-jx](https://github.com/jenkins-x/octant-jx) an open source JayeX UI for [vmware-tanzu/octant](https://github.com/vmware-tanzu/octant) ## Libraries These are the modular libraries which have been refactored out of the main [jenkins-x/jx](https://github.com/jenkins-x/jx) repository as part of the [modularisation enhancement process](https://github.com/jenkins-x/enhancements/tree/master/proposals/5#1-overview) * [go-scm](https://github.com/jenkins-x/go-scm) API for working with SCM providers * [jx-api](https://github.com/jenkins-x/jx-api) the core JX APIs * [jx-helpers](https://github.com/jenkins-x/jx-helpers) a bunch of utilities (mostly from the `util` package) refactored + no longer dependent on [jenkins-x/jx](https://github.com/jenkins-x/jx/) * [jx-kube-client](https://github.com/jenkins-x/jx-kube-client) the core library for working with kube/jx/tekton clients * [jx-logging](https://github.com/jenkins-x/jx-logging) logging APIs * [lighthouse-client](https://github.com/jenkins-x/lighthouse-client) client library for working with [lighthouse](https://github.com/jenkins-x/lighthouse) --- ## File: docs/cmd/jx.md ## jx JayeX 3.x command line ### Usage ``` jx ``` ### Synopsis JayeX 3.x command line ### Options ``` -h, --help help for jx ``` ### SEE ALSO * [jx add](jx_add.md) - Adds one or more resources * [jx create](jx_create.md) - Create one or more resources * [jx ctx](jx_ctx.md) - alias for: jx context * [jx dashboard](jx_dashboard.md) - View the JayeX Pipelines Dashboard * [jx get](jx_get.md) - Display one or more resources * [jx import](jx_import.md) - alias for: jx project import * [jx namespace](jx_namespace.md) - View or change the current namespace context in the current Kubernetes cluster * [jx start](jx_start.md) - Starts a resource * [jx stop](jx_stop.md) - Stops a resource * [jx upgrade](jx_upgrade.md) - Upgrades resources * [jx version](jx_version.md) - Displays the version of this command ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_add.md ## jx add Adds one or more resources ### Usage ``` jx add TYPE [flags] ``` ### Synopsis Adds one or more resources ### Options ``` -h, --help help for add ``` ### SEE ALSO * [jx](jx.md) - JayeX 3.x command line * [jx add app](jx_add_app.md) - alias for: jx gitops helmfile add ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_add_app.md ## jx add app alias for: jx gitops helmfile add ***Aliases**: chart* ### Usage ``` jx add app ``` ### Synopsis alias for: jx gitops helmfile add ### Options ``` -h, --help help for app ``` ### SEE ALSO * [jx add](jx_add.md) - Adds one or more resources ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_create.md ## jx create Create one or more resources ### Usage ``` jx create TYPE [flags] ``` ### Synopsis Create one or more resources ### Options ``` -h, --help help for create ``` ### SEE ALSO * [jx](jx.md) - JayeX 3.x command line * [jx create project](jx_create_project.md) - alias for: jx project * [jx create pullrequest](jx_create_pullrequest.md) - alias for: jx project pullrequest * [jx create quickstart](jx_create_quickstart.md) - alias for: jx project quickstart * [jx create spring](jx_create_spring.md) - alias for: jx project spring ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_create_project.md ## jx create project alias for: jx project ### Usage ``` jx create project ``` ### Synopsis alias for: jx project ### Options ``` -h, --help help for project ``` ### SEE ALSO * [jx create](jx_create.md) - Create one or more resources ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_create_pullrequest.md ## jx create pullrequest alias for: jx project pullrequest ***Aliases**: pr* ### Usage ``` jx create pullrequest ``` ### Synopsis alias for: jx project pullrequest ### Options ``` -h, --help help for pullrequest ``` ### SEE ALSO * [jx create](jx_create.md) - Create one or more resources ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_create_quickstart.md ## jx create quickstart alias for: jx project quickstart ***Aliases**: qs* ### Usage ``` jx create quickstart ``` ### Synopsis alias for: jx project quickstart ### Options ``` -h, --help help for quickstart ``` ### SEE ALSO * [jx create](jx_create.md) - Create one or more resources ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_create_spring.md ## jx create spring alias for: jx project spring ***Aliases**: sb* ### Usage ``` jx create spring ``` ### Synopsis alias for: jx project spring ### Options ``` -h, --help help for spring ``` ### SEE ALSO * [jx create](jx_create.md) - Create one or more resources ###### Auto generated by spf13/cobra on 16-Jun-2026 --- ## File: docs/cmd/jx_ctx.md ## jx ctx alias for: jx context ### Usage ``` jx ctx ``` ### Synopsis alias for: jx context ### Options ``` -h, --help help for ctx ``` ### SEE ALSO * [jx](jx.md) - JayeX 3.x command line ###### Auto generated by spf13/cobra on 16-Jun-2026 ## 2. Official Technical Reference & Guides (jenkins-x/jx-docs) # The Jenkins X project is changing name to JayeX and jenkins-x.io is redirected to jayex.io The source for the new site lives in https://github.com/jayex-io/jx-docs [中文](./README_CN.md) [](https://gitpod.io/#https://github.com/jenkins-x/jx-docs) # Jenkins X Docs This repository contains the source files for [jenkins-x.io](http://jenkins-x.io/) **NOTE:** Please browse these docs on [jenkins-x.io](http://jenkins-x.io/). Not all links work when browsing the Markdown files inside this repository. --- - [Building the docs](#building-the-docs) - [Preparing the sources](#preparing-the-sources) - [Git submodules](#git-submodules) - [Downloading npm modules](#downloading-npm-modules) - [Running Hugo](#running-hugo) - [Locally](#locally) - [Dockerized](#dockerized) - [Common Workflows](#common-workflows) - [Running spell check](#running-spell-check) - [Checking links, images, etc](#checking-links-images-etc) - [Adding redirects](#adding-redirects) - [Upgrading the enhancements content](#upgrading-the-enhancements-content) - [Localization](#localization) - [Contributing](#contributing) --- ## Building the docs ### Preparing the sources To edit the docs locally, you need to clone this repository: ```bash git clone --recurse-submodules --depth 1 https://github.com/jenkins-x/jx-docs.git ``` #### Git submodules Notice the use of `--recurse-submodules` in the clone command above. This option will pull in two git [submodules](https://git-scm.com/book/en/v2/Git-Tools-Submodules), namely [docsy](https://github.com/google/docsy) and [labs-enhancements](https://github.com/jenkins-x/enhancements). If you already have a git clone without the submodules checked out you can run: ```bash git submodule update --init --recursive ``` In subsequent updates of the sources via `git pull` also remember to pull the changes from the submodules: ```bash git pull --recurse-submodules ``` you can view the commit sha of the sub-modules via: ```bash git submodule status --recursive ``` ### Downloading npm modules After getting all the sources, you need to [install npm](https://www.npmjs.com/get-npm) and make sure the required npm modules are installed: ```bash npm install ``` ### Running Hugo The site itself is built with [Hugo](https://gohugo.io/) and configured in [`config.toml`](./config.toml). You have two options to run Hugo, either directly on your machine or via [Docker Compose](https://github.com/docker/compose). The following two sections describe the two alternatives in more detail. **NOTE:** Hugo renders the site in memory in development mode. Per default, no content is written to disk. #### Locally If you want to build the site locally on your machine, you need to [install](https://gohugo.io/getting-started/installing) Hugo. Check the [Makefile](./Makfile) for the latest recommended version use and check whether the environment variables of Golang are set. Set the env variable HUGO_GH_ACCESS_TOKEN to a github token that can read from jenkins-x/jx repo to allow the contributors plugin to run. Once installed, you can run: ```bash make server ``` You can now access the site under [localhost:1313](http://localhost:1313). #### Dockerized Instead of installing Hugo locally, you can use the provided `docker-compose.yml` to spin up the Hugo server in a containerized environment. Make sure you have [Docker](https://docs.docker.com/install/) installed. ```bash make compose-up ``` You can now access the site under [localhost:1313](http://localhost:1313). The Hugo server is running in the background. You can stop it via: ```bash make compose-down ``` ## Common Workflows ### Running spell check We are not all masters of spelling, so luckily there are tools to help us fix that. We are using [node-markdown-spellcheck](https://github.com/lukeapage/node-markdown-spellcheck) to run through all our markdown files and list any spelling issue or unknown word. To make this as simple as possible, just run the following command: ```bash make spellcheck ``` The report likely includes words that are spelt correctly, but that just means the spell checker is not aware of the correct spelling (happens a lot for technical terms, commands, etc.). Please edit [`.spelling`](./.spelling) and add the unknown word. Also, please try and keep the list alphabetically sorted, which makes it easier to navigate. ### Checking links, images, etc To get help in checking all the links, we'll use [htmlproofer](https://github.com/chabad360/htmlproofer). ```bash make linkcheck ``` **NOTE:** The initial run is really slow (due to external link checks) and that the cache is only build up when it finishes. **NOTE:**: It's safe to ignore the `... x509: certificate ...` errors for now ### Adding redirects If you move a page to a different location you can add a redirect via using an _aliases_ entry in the header of the page: ```yaml aliases: - /some/old/path - /another/path ``` ### Upgrading the enhancements content To upgrade to a new enhancements commit - we'll hopefully automate this soon! ```bash cd content/en/docs/labs/enhancements git checkout master git pull cd .. git add enhancements git commit -m "move to latest enhancements" ``` ### Upgrading docsy Docsy is added to the jx-docs repository as a submodule under the themes directory. To update docsy, run the following commands: ```bash cd themes/docsy git pull origin master git submodule update --init --recursive ``` ## Localization To let more people know Jenkins X better, localization is essential and meaningful. And we should keep some rules about this, please read related languages below: - [Chinese](Localization_Chinese.md) ## Contributing Please refer to the documentation contributing guide available at [Jenkins X website](https://jenkins-x.io/community/documentation/).