snyk / snyk/driftctl-docs

help users with zsh

Open
#206 1 comment 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

kind/documentation
Dominant language
MDX
Stars
7
Forks
14
PR merge metrics
No merged PRs in 30d

Description

zsh is installed by default on macs and this is a bad experience as I just used what worked on bash + on the docs:

$ driftctl scan --from tfstate://**/*.tfstate
zsh: no matches found: tfstate://**/*.tfstate
$ bash
bash-3.2$ driftctl scan --from tfstate://**/*.tfstate
Scanned states (3)
Found resources not covered by IaC:
  aws_internet_gateway:
    - igw-01f1b9d38973e31ce
[...]

On zsh we should use something like driftctl scan --from 'tfstate://**/*.tfstate'

Let's update the docs!

It works well with bash too:

bash-3.2$ driftctl scan --from 'tfstate://**/*.tfstate'
Scanned states (3)
Found resources not covered by IaC:
  aws_internet_gateway:
    - igw-01f1b9d38973e31ce
[...]

Why not documenting using the quotes be the default?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Search the documentation for the driftctl scan example using tfstate://**/*.tfstate. Update the default command to quote the glob, then check the rendered example against the bash and zsh behavior shown in the issue; done means the documented command works in both shells.

Written by the indexing model from the issue text.

Assessment

Tech stack
bash, zsh
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.