Skip to content

Update chef gem command doc for adding habitat gem install #4728

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

Closed
sanghinitin wants to merge 3 commits into from
Closed

Update chef gem command doc for adding habitat gem install #4728

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c72f72e
Update chef gem command doc for adding habitat gem install
sanghinitin Aug 24, 2026
61ac254
Pipeline fix
sanghinitin Aug 26, 2026
2d8dbb0
Pr review suggestion change
sanghinitin Sep 1, 2026
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
22 changes: 16 additions & 6 deletions content/workstation/26.1/tools/ctl_chef.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The `chef` executable is a command-line tool that does the following:

- Generates repositories, cookbooks, recipes, attributes, templates, and custom resources.
- Installs gems into the Chef development environment's Ruby installation.
- Helps you manage your [Policyfiles](/client/latest/policy/policyfile/). Please refer the Policyfile commands [section](#policyfile-commands).
- Helps you manage your [Policyfiles](/client/latest/policy/policyfile/). Refer to the Policyfile commands [section](#policyfile-commands).

{{< note >}}

Expand All @@ -31,7 +31,7 @@ To use a different cache location, set the `CHEF_WORKSTATION_HOME` environment v

## chef capture

The Chef Workstation 26 no longer support `chef capture` command.
Chef Workstation 26 no longer supports the `chef capture` command.

## chef env

Expand Down Expand Up @@ -87,12 +87,22 @@ None.
## chef gem

The `chef gem` subcommand is a wrapper around the `gem` command in
RubyGems and is used by Chef to install RubyGems into Chef Workstation
RubyGems and is used by Chef to install RubyGems into the Chef Workstation
development environment. All knife plugins, drivers for Kitchen, and
other Ruby applications that aren't packaged within Chef Workstation
will be installed to the `.Chef Workstation` path in the home directory:
`~/.Chef Workstation/gem/ruby/version#/bin` (where `version#` is the
version of Ruby that's packaged within Chef Workstation).
are stored in `~/.chef/ruby/version#/bin` and persist across Chef Workstation upgrades and downgrades.

### Premium gems

Chef Workstation can install premium gems from the Chef Premium RubyGem server at rubygems.chef.io. When you run a `chef gem` command, for example `chef gem install premium-gem`, Chef Workstation automatically checks whether rubygems.chef.io is already configured and, if not, attempts to add it.

If you don't configure a gem source for Chef premium gems, you can't install them.

{{< note >}}

The `chef gem` command never prompts interactively for a license key. To configure a license key, run `chef license add` first.

{{< /note >}}

### Syntax

Expand Down
Loading