> For the complete documentation index, see [llms.txt](https://docs.spotml.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spotml.io/running-jobs/spotml-run.md).

# spotml run

Schedule a cloud managed **run.**&#x20;

```
spotml run <script_name>
```

So if the spotml.yaml file has a script like below configured

```yaml
scripts:
  train: |
    python train.py
```

Then the below command basically queues a managed **run** in the spotML cloud

```
spotml run train
```

The scheduled run It tries to do the following:&#x20;

* If the instance is **not** running - Try spawning the spot instance.
* If a spot instance is not available, retry launching every 15 mins, until spot capacity is available.&#x20;
* If the instance is running - SSH into the session and run the above script.

### Named argument

```
spotml run stop
```

**stop** is a special named argument. If you intend to cancel the scheduled run, use above command.&#x20;

Note that if there is an active running script, you need to manually kill the process by `spotml sh run` and terminate the process. Otherwise the Idle time checker will continue to think there is an active command running.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.spotml.io/running-jobs/spotml-run.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
