https://github.com/bpkg/osx-screencast
Easily create a screencast on OS X in a few commands
https://github.com/bpkg/osx-screencast
Last synced: 10 months ago
JSON representation
Easily create a screencast on OS X in a few commands
- Host: GitHub
- URL: https://github.com/bpkg/osx-screencast
- Owner: bpkg
- License: mit
- Created: 2014-05-27T20:40:40.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2014-05-27T21:25:30.000Z (over 11 years ago)
- Last Synced: 2025-04-13T14:06:15.113Z (10 months ago)
- Language: Shell
- Size: 15.6 MB
- Stars: 105
- Watchers: 15
- Forks: 5
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
osx-screencast
==============
Easily create a screencast on OS X in a few commands.
Inspired from [this gist](https://gist.github.com/dergachev/4627207)
## install
```sh
$ bpkg install osx-screencast
```
## example
**record**
**export**
## usage
The `osx-screencast-record` command basically just opens up an
application with `open -a` defaulting to `Quicktime Player` as the
application that gets opened. The `-a` or `--application` can be used to
override this values.
### record
```sh
$ osx-screencast record
Opening `Quicktime Player'...
```
Record your screen in the application you've chosen and save the file.
You will need to know the path to the file you've saved because it will
be the `source` of the `osx-screencast-export` command.
### export
The `osx-screencast-export` command wraps the use of `ffmpeg` and
`convert` with default arguments. You can define the output fps for a video
with the `-f` or `--fps` option. The default is `10`. The delay between
each frame in the output can be defined in milliseconds with the `-d` or
`--delay` option. The default is `5`. The output scale can be defined
with the `-s` or `--scale` option. The default is `320:-1`. See [this
link](https://trac.ffmpeg.org/wiki/Scaling%20(resizing)%20with%20ffmpeg)
for more information on `ffmpeg` scaling.
```sh
$ osx-screencast export screencast.mov screencast.gif -s '720:-1'
Transcoding frames...
Converting and writing to destination...
Ok! (screencast.mov => screencast.gif)
```
## api
### osx-screencast
```
usage: osx-screenshot [-hV]
or: osx-screenshot record [-h] [-a application]
or: osx-screenshot export [-h] [-f fps] [-s scale] [-d delay]
```
### record
```
usage: osx-screenshot-record [-h]
or: osx-screenshot-record [-a application]
options:
-a,--application Set screen recording application (Default: 'Quicktime Player')
-h,--help Show this message
```
### export
```
usage: osx-screenshot-export [-h]
or: osx-screenshot-export [-f fps] [-s scale] [-d delay]
options:
-f,--fps Frames per second (Default: 10)
-s,--scale Output scaling (Default: 320:-1)
-d,--delay Frame delay
-h,--help Show this message
```
## license
MIT