https://github.com/720kb/yogurl

Serve files and code over HTTP in one command. The CLI for http://yogurl.io
https://github.com/720kb/yogurl

cli command-line file-sharing files http link serve urlify urls

Last synced: 2 days ago
JSON representation

Serve files and code over HTTP in one command. The CLI for http://yogurl.io

• Host: GitHub
• URL: https://github.com/720kb/yogurl
• Owner: 720kb
• License: mit
• Created: 2016-09-27T13:01:07.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-03T16:40:13.000Z (about 7 years ago)
• Last Synced: 2024-10-01T11:18:21.402Z (about 1 month ago)
• Topics: cli, command-line, file-sharing, files, http, link, serve, urlify, urls
• Language: JavaScript
• Homepage:
• Size: 20.5 KB
• Stars: 45
• Watchers: 3
• Forks: 6
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-starred - 720kb/yogurl - Serve files and code over HTTP in one command. The CLI for http://yogurl.io (http)

README

        


  

    

  

  
Serve your files and code over HTTP in one command.






























### What's Yogurl?

Yogurl is the simple command line tool for [Yogurl.io](http://yogurl.io)

It can be used as a [CLI](#cli-installation) command or as a [Node dependency](#node-usage) if you prefer.

### Requirements

Node.js v5+

### CLI Installation

```bash

npm install -g yogurl

```

### CLI Usage

```bash

$ yogurl  [ext]

```

```source```: A valid file path or code string

```ext```: A valid output [extension](#available-output-file-extensions) available

#### Yogurlify a file

```bash

$ yogurl path/to/file.js

```

#### Yogurlify a file to new extension

```bash

$ yogurl path/to/file.txt js

```

#### Yogurlify a code string

```bash

$ yogurl ".yogurl{ display:yogurl; }" css

```

### Node Usage

#### Installation

```bash

$ npm install yogurl --save

```

#### Yogurlify a file

```javascript

const Yogurl = require('yogurl');

Yogurl.upload('/path/to/file.json', 'json').then((data) => {

  //file is ready

  console.log(data, '');

  console.log(`File is ready at: ${data.data}`);

}).catch((err) => {

  //error

  console.log(err);

});

```

#### Yogurlify a code string

```javascript

const Yogurl = require('yogurl');

Yogurl.upload("var x = 'yogurlify a javascript var';", 'js').then((data) => {

  //file is ready

  console.log(data, '');

  console.log(`File is ready at: ${data.data}`);

}).catch((err) => {

  //error

  console.log(err);

});

```

### Available Output File Extensions

`.js`

`.css`

`.scss`

`.map`

`.json`

.... and others to come!

### Available Input File Extensions

ANY (supposed)

### Why Yogurl?

Yogurl has been developed with one simple goal: urlify code and files as quick as possible.

It is built for **development purposes**, it's not really recommended to use it in a production environment, **yogurl urls gets deleted after some time, so that you don't have to take care about them**.

Since Yogurl is not backed by any sponsor or funds of any kind: we apologize for any trouble/problem/issue that could eventually happen.

Please don't spam it and use it with moderation, Yogurl is your friend.

### Contact Yogurl

Feel free to open an issue or contact us on [twitter](http://twitter.com/720kb_) or come chat on [Gitter](https://gitter.im/720kb/yogurl/)

### Contributing

We are much grateful if you help us to grow and improve the project.

Contribute by forking, opening issues, pull requests or whatever.

### License

[MIT](http://github.com/720kb/yogurl/blob/master/LICENSE.md)