> For the complete documentation index, see [llms.txt](https://skypesky.gitbook.io/to-where-cli/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://skypesky.gitbook.io/to-where-cli/get-started.md).

# Get Started

[![npm version](https://img.shields.io/npm/v/to-where-cli.svg?style=flat-square)](https://www.npmjs.org/package/to-where-cli) [![Build Status](https://github.com/skypesky/to-where-cli/workflows/integration/badge.svg?branch=release)](https://github.com/skypesky/to-where-cli/actions) [![install size](https://img.shields.io/badge/dynamic/json?url=https://packagephobia.com/v2/api.json?p=to-where-cli\&query=$.install.pretty\&label=install%20size\&style=flat-square)](https://packagephobia.now.sh/result?p=to-where-cli) [![npm downloads](https://img.shields.io/npm/dm/to-where-cli.svg?style=flat-square)](https://npm-stat.com/charts.html?package=to-where-cli)

> Currently only supports [macOS](https://en.wikipedia.org/wiki/MacOS), [Windows](https://en.wikipedia.org/wiki/Windows)

Use the alias mechanism to help you open obscure URLs that are hard to remember. Helps you to open various addresses of github repositories, straight to the search page of npm, google and other sites.

### Features

* [x] Open hard-to-remember websites by alias
* [x] Open various pages of the github repository (issue, pull request, start...)
* [x] Go straight to the search npm page
* [x] Go straight to the search github page
* [x] Go straight to the search google page
* [x] Go straight to the search bing page
* [x] Go straight to the search baidu page

### Install 

```
npm install -g to-where-cli
```

### Basic usage

* Add an alias to your address

```sh
tw add home https://github.com/skypesky
```

* Open address by alias

```sh
tw home
```

* Update the address of the alias

```sh
tw add home https://github.com/skypesky/leetcode-for-javascript
```

* List existing alias home

```sh
tw ls home
```

* Remove an alias from your address

```sh
tw rm home
```

* Show help information

```
tw -h
```

### Advance usage

#### tw git

```
tw git #Open the address of the current branch
tw git -c #Open the commit page for a given SHA hash.
tw git -i #Open the issues list page (default: false).
tw git -p #Open the pull request list page (default: false).
tw git --star #Open the star page (default: false).
```

#### tw npm

```
#Go straight to the npm search page and search for the keyword to-where-cli
tw npm to-where-cli
```

#### tw github

```
#Go straight to the github search page and search for the keyword to-where-cli
tw github to-where-cli 
```

#### tw google

```
#Go straight to google's search page and search for the keyword to-where-cli
to google "skypesky to-where-cli"
```

#### tw bing

```
#Go straight to bing's search page and search for the keyword to-where-cli
to bing to-where-cli
```

#### tw baidu

```
#Go straight to baidu's search page and search for the keyword to-where-cli
to baidu to-where-cli
```

If you want to know more about the usage, please refer to the [subsequent](/to-where-cli/basic-usage/basic-command.md)[ tutorials](/to-where-cli/basic-usage/basic-command.md).