PaloAltoNetworks / PaloAltoNetworks/pan.dev

Issue with "Getting Started with twistcli"

Open
#766 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
MDX
Stars
78
Forks
88
Avg merge
5d 17h
Merged PRs (30d)
18

Description

Documentation link

https://pan.dev/prisma-cloud/docs/twistcli_gs/#scan-images-when-the-docker-socket-isnt-in-the-default-location

Describe the problem

  1. space needed in --docker-address PATH

    --docker-addressPATH -- Path to the Docker socket. By default, twistcli looks for the Docker socket in unix:///var/run/docker.sock.

  2. example command cut short:

    $ ./twistcli images scan \
      --address=<COMPUTE_CONSOLE> \
      --user=<TW_USER> \
      --password=<TW_PASSWORD> \
      --docker-ad
    

Suggested fix

  1. add the space
  2. complete the example

Contributor guide

Open the contributing guide

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

Open the linked twistcli Getting Started section, especially the example for scanning images when the Docker socket is not in its default location. Correct the missing space in --docker-address PATH and complete the truncated --docker-ad example; the documentation is done when the option text and command are complete and usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
cli, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.