mirror of
https://github.com/simstudioai/sim.git
synced 2026-01-14 17:37:55 -05:00
ae43381d84
* feat(domain): drop the * change all references for Sim Studio to Sim * change back license and notice * lint --------- Co-authored-by: waleedlatif <waleedlatif@waleedlatifs-MacBook-Pro.local>
36 lines
622 B
Markdown
36 lines
622 B
Markdown
# Sim CLI
|
|
|
|
Sim CLI allows you to run [Sim](https://sim.ai) using Docker with a single command.
|
|
|
|
## Installation
|
|
|
|
To install the Sim CLI globally, use:
|
|
|
|
```bash
|
|
npm install -g simstudio
|
|
```
|
|
|
|
## Usage
|
|
|
|
To start Sim, simply run:
|
|
|
|
```bash
|
|
simstudio
|
|
```
|
|
|
|
### Options
|
|
|
|
- `-p, --port <port>`: Specify the port to run Sim on (default: 3000).
|
|
- `--no-pull`: Skip pulling the latest Docker images.
|
|
|
|
## Requirements
|
|
|
|
- Docker must be installed and running on your machine.
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcome! Please open an issue or submit a pull request.
|
|
|
|
## License
|
|
|
|
This project is licensed under the Apache-2.0 License. |