scrimba
v0.4.4
Published
CLI for scrimcasting from your local environment
Downloads
10
Readme
CLI for live-streaming your local dev environment
Scrimba is a screen sharing tool for developer teams. It's command line-based and allows you to do the following:
- Live stream your local dev environment to a URL
- Collaborate in real-time and discuss via voice chat
- Keep a recording of the session afterwards
The most popular use-cases are code review, onbarding, and documentation.
Quick-start
# install the CLI
$ npm -g install scrimba
# navigate to your project
$ cd my-awesome-project
# start a live stream
$ scrimba start
This will open my-awesome-project
as a scrim in Chrome, which will look something like this:
Now you'll be able to interact with your local workspace via this scrim. This means that you can edit and save files, and run commands in the terminal. To start collaborating, simply share the URL with a colleague and she'll be able to jump into your local workspace instantly.
All features
- Codebase, terminal and browser sharing
- Real-time collaboration
- Mouse pointer for each participant
- Voice chat
- Conferences (up to 4 people)
- Record sessions
- Dashboard for recorded sessions
Feedback
This is an experimental feature, and you're likely to encounter bugs. Please report any bugs, quirks, or invconveniences to us via our Slack group, as it'll help us improve the experience. We'd also love to hear any suggestions you might have. You can also follow us reach out at Twitter.
Limitations
It currently only works to stream via Google Chrome
Troubleshooting
If you have trouble installing scrimba without sudo, read up on fixing-npm-permissions
prebuild-install WARN install EACCES: permission denied, mkdir '/path/to/node_modules/node-pty-prebuilt/build'
# If you really need to install with sudo, and get the error above, install using --unsafe-perm:
sudo npm install -g scrimba --unsafe-perm