https://github.com/xwmx/osx-cli

A collection of command line shortcuts for common OS X operations.
https://github.com/xwmx/osx-cli

macos osx osx-cli shell

Last synced: 5 months ago
JSON representation

A collection of command line shortcuts for common OS X operations.

Host: GitHub
URL: https://github.com/xwmx/osx-cli
Owner: xwmx
License: mit
Created: 2015-01-25T23:02:36.000Z (over 10 years ago)
Default Branch: master
Last Pushed: 2019-10-22T20:49:52.000Z (almost 6 years ago)
Last Synced: 2024-05-02T00:56:12.819Z (over 1 year ago)
Topics: macos, osx, osx-cli, shell
Language: Shell
Homepage:
Size: 74.2 KB
Stars: 24
Watchers: 3
Forks: 2
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

_ _
___ _____ __ ___| (_)
/ _ \/ __\ \/ / / __| | |
| (_) \__ \> < | (__| | |
\___/|___/_/\_\ \___|_|_|

# osx-cli

A collection of command line shortcuts for common OS X operations.

This is a work in progress.

## Installation

### Manual

To install manually, simply add the `osx` script to your `$PATH`. If
you already have a `~/bin` directory, you can use the following command:

curl -L https://raw.github.com/alphabetum/osx-cli/master/osx \
-o ~/bin/osx && chmod +x ~/bin/osx

## Commands

A selection of included commands. To see the full list, run `osx
commands`.

### `accounts`

```
Usage:
osx accounts (list | login | logout [--force] | window)

Subcommands:
list List login user accounts.
login Log in as the specified user, aka "Fast User Switching."
logout Log out the current user.
window Go to the OS X login window.

Options:
--force Suppress confirmation prompt.
```

### `airport`

Subcommands:
on Turn wireless on.
off Turn wireless off.
info Show the current airport status.
quality Show the wireless quality as a percentage.
scan Perform a scan for wireless networks.
join Join the specified network.
```

### `battery`

```
Usage:
osx battery [-l|--long]
osx battery status [-l|--long]
osx battery cycles
osx battery health

Subcommands:
status Current battery status.
cycles Number of battery cycles.
health Health of the battery, using the current maximum capacity as
percentage of the battery's design capacity).

Options:
-l --long Print longform information about the battery status.

Description:
Print battery info. When no subcommand is specified, display `status`.

```

### `caffeinate`

```
Usage:
osx caffeinate [-disu] [-t timeout] [command] [arguments]

Description:
Prevent the system from sleeping on behalf of a utility.

This is simply a bookmark for the caffeinate command.

See `man caffeinate` for more information.

Examples:
caffeinate -u -t 3600
Prevent sleeping for one hour (3,600 seconds).

caffeinate -s scp bigfile me:myserver/bigfile
Prevent sleeping until the secure file copy (scp) completes.
```

### `desktop`

```
Usage:
osx desktop ( hide | show )

Description:
Hide/show all desktop icons (useful when presenting).
```

### `eject`

```
Usage:
osx eject

Description:
Ejects a given volume (eg, a disk image).
```

### `fans`

```
Usage:
osx fans

Description:
Display fan stats via iStats.

More information:
https://github.com/Chris911/iStats
```

### `finder`

```
Usage:
osx finder hidden ( hide | show )

Description:
Hide/show hidden files in the Finder.
```

### `jsc`

```
Usage:
osx jsc []

Description:
Run the JavaScriptCore REPL.

If no argument is provided, launch an interactive REPL session. If a
filename is provided as the second argument, run that file with jsc.
```

### `lock`

```
Usage:
osx lock

Description:
Lock the screen (when going AFK).
```

### `login-items`

```
Usage:
osx login-items list
osx login-items add [--hide]
osx login-items show ( |
osx login-items delete ( | )

Subcommands:
list List current login items.
add Add a login item using the full path to the .app.
show Print the properties for a login item using either the name, found
via the `list` subcommand, or the full path to the item.
delete Delete a login item using either the name, found via the `list`
subcommand, or the full path to the item.

Description:
List, add, show, and delete login items.

More information:
https://hamstergene.github.io/post/editing-osx-login-items-cmdline/
```

### `memory`

```
Usage:
osx memory

Description:
Print memory (RAM) usage information.
```

### `play`

```
Alias for `afplay`

Audio File Play
Version: 2.0
Copyright 2003-2013, Apple Inc. All Rights Reserved.
Specify -h (-help) for command options

Usage:
osx play [option...] audio_file

Options: (may appear before or after arguments)
{-v | --volume} VOLUME
set the volume for playback of the file
{-h | --help}
print help
{ --leaks}
run leaks analysis
{-t | --time} TIME
play for TIME seconds
{-r | --rate} RATE
play at playback rate
{-q | --rQuality} QUALITY
set the quality used for rate-scaled playback
(default is 0 - low quality, 1 - high quality)
{-d | --debug}
debug print output
```

### `process`

```
Usage:
osx process pause ( | -n --name )
osx process continue ( | -n --name )
osx process throttle
osx process kill ( | -n --name )

Description:
Pause, continue, throttle, or kill a given process.

Dependency:
cputhrottle
http://www.willnolan.com/cputhrottle/cputhrottle.html
```

### `ql`

```
Usage:
osx ql

Description:
Open items with Quick Look.
```

### `sleep`

```
Usage:
osx sleep

Description:
Put the system to sleep immediately.
```

### `spotlight`

```
Usage:
osx spotlight search ( | )
osx spotlight filename
osx spotlight disable
osx spotlight enable

Description:
Spotlight searching and controls.
```

### `sshd`

```
Usage:
osx sshd ( start | stop | status )

Description:
Start, stop, or get the status of sshd for remote login
```

### `stats`

```
Usage:
osx stats

Description:
Display temperature, fan, and battery status via iStats.

More information:
https://github.com/Chris911/iStats
```

### `temp`

```
Usage:
osx temp

Description:
Display CPU and battery temperature via iStats.

More information:
https://github.com/Chris911/iStats
```

### `textutil`

```
Usage:
osx textutil [command_option] [other_options] file...

Description:
textutil can be used to manipulate text files of various formats, using the
mechanisms provided by the Cocoa text system.

This is simply a bookmark for the system's textutil utility.

See `man textutil` for more information.

Examples:
textutil -convert html MyWordFile -output /tmp/webfile.html
Convert a Word document into HTML.

textutil -info MyWordFile
Display information about the file format.
```

### `trash`

```
Usage:
osx trash ( empty [--secure] [--all] | open )

Subcommands:
empty Empty the trash.
open Open the trash folder in the finder.

Options:
--secure Use `srm` to securely delete trash contents.
--all Empty trashes on all connected volumes.
```

### `vnc`

```
Usage:
osx vnc ( start | stop | status )

Description:
Start, stop, or get the status of vnc aka Screen Sharing aka Remote Desktop
```

### `volume`

```
Usage:
osx volume ( <0-9> | <00-100> | mute | unmute )

Arguments:
Print the current output volume level as a percent.
<0-9> Set the output volume to about the nearest tenth percent. Sometimes
the actual number is slightly off for reasons unknown.
<00-100> Set the output volume to the specified percent.
mute Mute output.
unmute Unmute output.
```

## Links

- [An A-Z Index of the Apple OS X command line (ss64.com)]
(http://ss64.com/osx/)
- [Eight Terminal Utilities Every OS X Command Line User Should Know (mitchchn.me)]
(http://www.mitchchn.me/2014/os-x-terminal/)
- [comments](https://news.ycombinator.com/item?id=10143143)
- [followup](http://www.mitchchn.me/2014/and-eight-hundred-more/)

## Related Projects

- [accounts - Command line / terminal tool for common OS X user account operations.]
(https://github.com/alphabetum/accounts)
- [airport - A command line interface for Wi-Fi on OS X.]
(https://github.com/alphabetum/airport)
- [search.sh - A command line search multi-tool.]
(https://github.com/alphabetum/search.sh)

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/xwmx/osx-cli

Awesome Lists containing this project

README