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

Streamline Fabric CLI interface #70

Closed
traut opened this issue Feb 5, 2024 · 1 comment · Fixed by #58
Closed

Streamline Fabric CLI interface #70

traut opened this issue Feb 5, 2024 · 1 comment · Fixed by #58
Labels
cli enhancement New feature or request
Milestone

Comments

@traut
Copy link
Member

traut commented Feb 5, 2024

Fabric CLI:

  • 2 subcommands:
    • render
      • the subcommand renders the specified document into Markdown and outputs it either to stdout or to a file.
      • target -- a required positional argument. Specifies the name of the document to be rendered as document.<name>.
      • --out-file -- an optional argument. Specifies the name of the output file where the rendered document must be saved to.
        • if --out-file is not set, the Markdown is printed to stdout
    • data
      • the subcommand executes the data block and prints out prettified (and highlighted) JSON to stdout

      • target -- a required positional argument. Specifies a path to a data block to be executed -- a data block must be inside a document, so the path should have syntax of document.<doc-name>.data.<plugin-name>.<data-name>.

  • subcommand-independent arguments
    • --source-dir -- an optional argument that accepts a path to a directory with *.fabric files. Default value: . (current directory)
    • --log-output -- an optional argument that accepts plain or json. Configures a handler for the logging. Default value: plain (colored plain text output). The logs (both plain and json formats) should be written to stderr
    • --logging-level -- an optional argument that specifies the logging level. Default value: info
    • -v -- a shortcut to --logging-level debug
@traut traut added the enhancement New feature or request label Feb 5, 2024
@traut traut added this to the v0.3 milestone Feb 5, 2024
@traut
Copy link
Member Author

traut commented Feb 7, 2024

based on the #58 (comment), decided to rename --logging-level to --log-level for clarity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cli enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant