https://github.com/zurb/notable-cli
Upload to Notable from the command-line
https://github.com/zurb/notable-cli
Last synced: about 1 year ago
JSON representation
Upload to Notable from the command-line
- Host: GitHub
- URL: https://github.com/zurb/notable-cli
- Owner: zurb
- License: mit
- Created: 2016-05-27T18:14:06.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2016-05-31T19:04:31.000Z (about 10 years ago)
- Last Synced: 2025-03-25T10:51:10.763Z (about 1 year ago)
- Language: Go
- Homepage: http://zurb.com/notable
- Size: 21.6 MB
- Stars: 7
- Watchers: 15
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Notable CLI
This is a command line interface (CLI) for [Notable](http://zurb.com/notable), a design feedback application by [ZURB](http://zurb.com). Right now it supports uploading sites to Notable Code. **This currently only supports Mac OSX.** Other systems are supported by [compiling from source](#compile-from-source).
## Install
Use [Homebrew](http://brew.sh/) to install the Notable CLI.
```
brew tap zurb/tap
brew install notable
```
You are now ready to go!
## Authenticate
Before you can use the CLI, you must authenticate it with your [Notable](http://zurb.com/notable) account.
```
notable login
```
Logout by running:
```
notable logout
```
Once authenticated, you can run any of the following commands.
## Upgrade
To get the latest changes to the Notable CLI, run the following command:
```
brew up && brew upgrade notable
```
## Upload to Notable Code
Capture any URL, including local URLs, by running the `code` command followed by the address of the site to capture. For instance, if you have a local application running at `localhost:3000` then run the following command to upload it to [Notable Code](http://zurb.com/notable/features/code).
```
notable code localhost:3000
```
Your browser will automatically open, once captured, to the Notable Code site that you just uploaded.
Capture live sites the same way:
```
notable code http://www.nytimes.com/
```
Or use the shorcut:
```
notable c http://zurb.com/notable
```
## Upload to Notable Notebooks
You can create a Notebook from a directory of images by running the following command from _inside_ the directory you want to upload.
```
notable notebook create
```
This command will upload all images in the current directory and open the Notebook in your browser when done.
Or use the shortcut:
```
notable n create
```
## Compile from source
The provided Homebrew binary is meant for Mac OSX, but if you would like to run the CLI on Windows or Linux based systems, compiling from source is your answer.
The Notable CLI is built in go, so install [go](https://golang.org) then clone down this repository into your working directory.
```
go get github.com/zurb/notable-cli
```
Then build it:
```
go build -o notable
```
That's it! You now have an executable binary for your OS.