chiptools.core.cli module

class chiptools.core.cli.CommandLine(project=None)

Bases: cmd.Cmd, object

do_add_tests(command)

Add the given tests to the test suite. Tests should be supplied as comma separated numbers or numeric ranges, for example:

add_tests 1-3, 5, 6, 7

Would add tests 1, 2, 3, 5, 6, 7 to the test suite.

You can check which tests are available by issuing the show_tests command or remove tests that have been added to the suite by issuing the remove_tests command.

do_clean(command)

Clear the file cache

do_compile(command)

do_exit(command)

do_graph(command)

do_load_project(path)

Load the given project XML file: load_project <path_to_project>

do_plugins(command)

do_pwd(command)

do_remove_tests(command)

Remove the given tests from the test suite. Tests should be supplied as comma separated numbers or numeric ranges, for example:

remove_tests 1-3, 5, 6, 7

Would remove tests 1, 2, 3, 5, 6, 7 from the test suite.

You can check which tests are available by issuing the show_tests command or add tests by issuing the add_tests command.

do_run_preprocessors(command)

For each project file in the design run any associated preprocessors. You can use this command to test that a preprocessor is running on your file correctly. Preprocessors are called automatically when you run synthesis

do_run_tests(command)

Run the tests that were selected via the add_tests command and report the results.

do_show_config(command)

Print out the project settings

do_show_synthesis_fileset(command)

Print out the synthesis file set

do_show_tests(command)

Show the tests available in the current project.

do_simulate(command)

Compile the given entity in the given library using the chosen simulator and invoke the simulator GUI. Example: (Cmd) simulate my_library.my_entity

do_synthesise(command)

Synthesise the design using the chosen synthesis tool and report any errors Example: (Cmd) simulate my_library.my_entity

locateProjects()

Return a list of projects found in the current path.

show_test_selection()

Show the currently selected tests in the current project. Add or remove tests using the add_tests and remove_tests commands respectively.

chiptools.core.cli.wraps_do_commands(fn)