Operations
Care has been spent in documenting each command and their parameters.
Please use the additional parameter --help to get documentation.
ℹ️
When the
--json flag is enabled, all commands except batch print machine-friendly JSON, instead of tables meant for human consumption.
If you plan to integrate the CLI into your workflows, this flag will facilitate that.AeroCloud
Usage: nf aerocloud <COMMAND>
Commands:
current-user Get information about the current user
current-token Get information about the token in use
set-auth-token Set a new auth token
set-org Set the organisation AeroCloud v7 commands operate within by default
unset-org Unset the default organisation, operating within your personal workspace
org Operate on organisations
v6 Operate on AeroCloud v6 (end-of-life, read-only)
v7 Operate on AeroCloud v7Organisations
Usage: nf aerocloud org <COMMAND>
Commands:
list List organisations the current user is a member ofSee Organisations for how to operate within an organisation.
AeroCloud v7
Usage: nf aerocloud v7 [OPTIONS] <COMMAND>
Commands:
batch Start an interactive UI to review and submit multiple simulations at once.
create-model Create a new model
create-project Create a new project
create-simulation Create a new simulation
delete-projects Delete projects
delete-simulations Delete simulations
list-projects List projects
list-reusable-models List reusable models
list-simulations List simulations
wait-for-simulations Wait for one or many simulations to succeed.
Options:
--org <ORG_ID> Operate within an organisation instead of your personal workspace [env: NF_AEROCLOUD_ORG=]
--personal Operate within your personal workspace, ignoring `--org` and the default organisationAeroCloud v6 (end-of-life, read-only)
Usage: nf aerocloud v6 <COMMAND>
Commands:
create-project Create a new project
delete-projects Delete projects
delete-simulations Delete simulations
list-projects List projects
list-simulations List simulations