Skip to content

Update install instructions#294

Merged
iMichaela merged 4 commits intousnistgov:developfrom
selenaxiao-nist:develop
Jun 25, 2025
Merged

Update install instructions#294
iMichaela merged 4 commits intousnistgov:developfrom
selenaxiao-nist:develop

Conversation

@selenaxiao-nist
Copy link

@selenaxiao-nist selenaxiao-nist commented Jun 3, 2025

Committer Notes

Updates install instructions to include where oscal-cli executable is, how to install locally

All Submissions:

Changes to Core Features:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your core changes, as applicable?
  • Have you included examples of how to use your new feature(s)?
  • Have you updated all website and readme documentation affected by the changes you made?

@selenaxiao-nist selenaxiao-nist requested a review from iMichaela June 3, 2025 16:10
Copy link

@iMichaela iMichaela left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@selenaxiao-nist - I suggest keeping the guidance related to maven. We will need to update it with the latest sonatype changes, and only add (as oppose to replace) the local installation guidance.

@selenaxiao-nist
Copy link
Author

@iMichaela I added the Maven guidance back.

README.md Outdated
unzip cli-core-1.0.3-oscal-cli.zip
```

4. (Recommended) Add oscal-cli's directory to your path.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@selenaxiao-nist - For non-developer, adding the oscal-cli to the path might be challenging without a step-by-step guidance (copy or soft link )

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@iMichaela I added more to the adding to PATH section.

@iMichaela iMichaela merged commit 4b99521 into usnistgov:develop Jun 25, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants