ifctester docs for command line use

This commit is contained in:
Andrej730
2024-04-16 14:21:21 +05:00
parent e1e169ece8
commit b458aea6b9
2 changed files with 18 additions and 2 deletions
+16
View File
@@ -4,6 +4,22 @@ With **IfcTester**, you can author and read **Information Delivery Specification
## How to use it
### Command line use
.. code-block:: bash
# run console reporter
python -m ifctester example.ids example.ifc
python -m ifctester example.ids example.ifc -r Html -o report.html
Available flags:
- ``-r`` / ``--reporter``: The reporting method to view audit results. Availabe reporters: Console, Txt, Json, Html, Ods, Bcf
- ``--no-color``: Disable colour output (supported by Console reporting).
- ``-o`` / ``--output``: Output file (supported for all types of reporting except Console).
### Code example
```python
import ifcopenshell
from ifctester import ids, reporter
+2 -2
View File
@@ -31,10 +31,10 @@ parser.add_argument(
"-r", "--reporter", type=str, help="The reporting method to view audit results", default="Console"
)
parser.add_argument(
"--no-color", help="Disable colour output supported by Console reporting", action="store_true"
"--no-color", help="Disable colour output (supported by Console reporting)", action="store_true"
)
parser.add_argument(
"-o", "--output", help="Output file supported by Json reporting"
"-o", "--output", help="Output file (supported for all types of reporting except Console)"
)
args = parser.parse_args()