Skip to content

Update cli.rst #13

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update cli.rst #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/cli.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Command-Line Interface
======================
For convenience Firetail provides a command-line interface
For convenience FireTail provides a command-line interface
(CLI). This interface aims to be a starting point in developing or
testing OpenAPI specifications with Firetail.
testing OpenAPI specifications with FireTail.

The available commands are:

Expand All @@ -13,18 +13,18 @@ All commands can run with -h or --help to list more information.
Running an OpenAPI specification
--------------------------------

The subcommand ``run`` of Firetail's CLI makes it easy to run OpenAPI
The subcommand ``run`` of FireTail's CLI makes it easy to run OpenAPI
specifications directly even before any operation handler function gets
implemented. This allows you to verify and inspect how your API will
work with Firetail.
work with FireTail.

To run your specification, execute in your shell:

.. code-block:: bash

$ firetail run your_api.yaml --stub --debug

This command will tell Firetail to run the ``your_api.yaml``
This command tells FireTail to run the ``your_api.yaml``
specification file attaching a stub operation (``--stub``) to the
unavailable operations/functions of your API and in debug mode
(``--debug``).
Expand Down