Specify the system as an option in the CLI, instead of as an argument (…

…#67) * set machine as option * rename machine as system * fix env var names * fix env var names * fix shortoption
eth-cscs · Sep 14, 2023 · db845f3 · db845f3
1 parent 4364b35
commit db845f3
Show file tree

Hide file tree

Showing 6 changed files with 174 additions and 127 deletions.
diff --git a/docs/source/tutorial_cli.rst b/docs/source/tutorial_cli.rst
@@ -23,18 +23,21 @@ Some basic examples:
  # Get the available systems
  firecrest systems
 
+ # Set the environment variable to specify the name of the system
+ export FIRECREST_SYSTEM=cluster1
+
  # Get the parameters of different microservices of FirecREST
  firecrest parameters
 
  # List files of directory
- firecrest ls cluster1 /home
+ firecrest ls /home
 
  # Submit a job
- firecrest submit cluster script.sh
+ firecrest submit script.sh
 
  # Upload a "small" file (you can check the maximum size in `UTILITIES_MAX_FILE_SIZE` from the `parameters` command)
- firecrest upload --type=direct cluster local_file.txt /path/to/cluster/fs
+ firecrest upload --type=direct local_file.txt /path/to/cluster/fs
 
  # Upload a "large" file
- firecrest upload --type=external cluster local_file.txt /path/to/cluster/fs
+ firecrest upload --type=external local_file.txt /path/to/cluster/fs
  # You will have to finish the upload with a second command that will be given in the output