Skip to content
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.

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

Introduce CLI Aliases to IF #699

Closed
4 tasks done
Tracked by #655
narekhovhannisyan opened this issue May 6, 2024 · 3 comments · Fixed by #697
Closed
4 tasks done
Tracked by #655

Introduce CLI Aliases to IF #699

narekhovhannisyan opened this issue May 6, 2024 · 3 comments · Fixed by #697
Assignees
Milestone

Comments

@narekhovhannisyan
Copy link
Member

narekhovhannisyan commented May 6, 2024

What

Introduce CLI shortcuts for IF flags to make UI simplier. Such as:

Why

To run the IF framework rapidly, use short keywords for --manifest, --output, --help and --stdout.

SoW (scope of work)

  • Documentation updated
  • QA Tested

Acceptance criteria

  • Updated IF with working shortcuts
  • GIVEN this update has been implemented and a user has downloaded and installed if
    WHEN a user runs the following command ie -m <path-to-a-manifest>
    THEN ie should execute identically to the command `ie --manifest
    The same should apply to the following mapping of shortkeys to commands:
shortkey command
-h --help
-m --manifest
-o --output
-s --stdout
  • Updated Documentation

The shortkeys should be described in the IF readme and on the CLI page on if.greensoftware.foundation

ie -h // help
ie -m <manifest-path> -o <output-path> -s // manifest, output paths, stdout
@MariamKhalatova MariamKhalatova linked a pull request May 6, 2024 that will close this issue
9 tasks
@jmcook1186 jmcook1186 moved this to In Progress in IF May 7, 2024
@zanete zanete moved this from In Progress to Pending Review in IF May 7, 2024
@MariamKhalatova MariamKhalatova moved this from Pending Review to Testing in IF May 7, 2024
@MariamKhalatova
Copy link
Contributor

@narekhovhannisyan Tested from my side, you can update the docs accordingly.

@github-project-automation github-project-automation bot moved this from Testing to Done in IF May 8, 2024
@jmcook1186 jmcook1186 reopened this May 8, 2024
@jmcook1186
Copy link
Contributor

reopening as docs not yet updated

@MariamKhalatova
Copy link
Contributor

@jmcook1186 @narekhovhannisyan Updated documentations accordingly
#708
Green-Software-Foundation/if-docs#73

@zanete zanete added this to the Improve Trust milestone Jun 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

4 participants