Running bench command from code

rahy · June 11, 2020, 5:26pm

Dear friends,

Is there any possibility to run a bench command from code (js or py)? For example from a button.
If can, what is the structure of the code?

Thank you

kt2152 · December 12, 2022, 9:05pm

Looking for the same , did you happen to find a way ?

Hardik_Zinzu · December 13, 2022, 5:01am

Hello, We can run any command through python using library called OS. Also you can give full path where frappe folder is exist. Or before os.system go to that folder through chdir()

import os

os.system('bench start')

Or

import subprocess

subprocess.run('bench start', shell=True)

ankush · December 13, 2022, 5:06am

Most bench commands in Framework are just functions in app/commands/<file>.py files.

You can call the relevant function instead calling it from shell. Don’t run the command function directly, copy the relevant part of command body instead. E.g. bench build command just calls another function called bundle

github.com

frappe/frappe/blob/develop/frappe/commands/utils.py#L85


      
          		if production:
          			mode = "production"
          
          
		if make_copy or restore:
          			hard_link = make_copy or restore
          			click.secho(
          				"bench build: --make-copy and --restore options are deprecated in favour of --hard-link",
          				fg="yellow",
          			)
          
          
		bundle(mode, apps=apps, hard_link=hard_link, verbose=verbose, skip_frappe=skip_frappe)
          
          

          
@click.command("watch")
          @click.option("--apps", help="Watch assets for specific apps")
          def watch(apps=None):
          	"Watch and compile JS and CSS files as and when they change"
          	from frappe.build import watch
          
          
	frappe.init("")
          	watch(apps)

If they are defined in bench then you can’t import them directly like this. Only way to run those would be subprocess call.