ScientiFlow CLI Application - How to use??

ScientiFlow CLI Application - How to use??

Command-Line Arguments
Authentication Commands
--login
Description: 
Use this command to securely log in to ScientiFlow. After running it, the CLI will prompt you to enter your registered email address and password to authenticate your account. The screenshot below illustrates how the CLI asks for your ScientiFlow credentials.

  1. scientiflow-cli --login
         
Upon providing valid credentials, your session is authenticated, allowing you to access ScientiFlow features and execute jobs through the CLI. 

--logout
Description: Use this command to log out from ScientiFlow. Executing it will terminate your active session.
  1. scientiflow-cli --logout
Users may choose not to run this command if they prefer to remain logged in on their device.Staying logged in keeps the configuration active and lets you submit new jobs without logging in again.


Job Management Commands:

--list-jobs
  1. Description: Use this command to display all jobs available for execution.
  1. scientiflow-cli --list-jobs
This command lists every job in your workspace, as shown in the attached screenshot. Once the jobs are listed, you can execute them using one of the following methods:

There are three ways to execute jobs using their Job IDs.
1. Execute a Single Job:
Run a specific job by providing its Job ID. Replace <ID> with the job ID you want to execute.  
  1. scientiflow-cli --execute-jobs <ID>
Example of Use:

2. Execute Multiple Jobs Sequentially:
Provide multiple Job IDs separated by spaces to run them one after another.
  1. scientiflow-cli --execute-jobs <ID> <ID> <ID>
Example of Use:

3. Execute Multiple Jobs in Parallel:
Add the -p or --parallel flag to execute multiple jobs simultaneously.
  1. scientiflow-cli --execute-jobs <ID> <ID> <ID> -p
 or
  1. scientiflow-cli --execute-jobs <ID> <ID> <ID> --parallel
Example of Use:


--execute-jobs
  1. Description: Execute all pending jobs.
  1. scientiflow-cli --execute-jobs
Retrieves and executes all pending jobs without following a specific order.

Additional Notes
  1. Use the --help option to display a comprehensive help message.
  2. Ensure you have valid credentials and sufficient permissions to perform job-related operations.
  3. For issues or questions, contact the ScientiFlow support team at scientiflow@gmail.com
This documentation provides everything you need to effectively use the ScientiFlow CLI Application. If further assistance is required, please reach out to support.






    

    • Related Articles
      • 

    • Installation of Scientiflow-CLI Agent application
      Installing ScientiFlow CLI The ScientiFlow CLI helps you quickly set up and run scientific workflows on your local workstation or cluster. Follow these simple steps to get started — no technical experience required. Step 1. Update your system Open ...
      •