https://github.com/dennisbruner/hcloud-js

A Node.js module for the Hetzner Cloud API
https://github.com/dennisbruner/hcloud-js

api cloud hetzner node nodejs wrapper

Last synced: 5 months ago
JSON representation

A Node.js module for the Hetzner Cloud API

• Host: GitHub
• URL: https://github.com/dennisbruner/hcloud-js
• Owner: dennisbruner
• License: mit
• Archived: true
• Created: 2018-01-25T15:25:03.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-05T16:14:18.000Z (over 1 year ago)
• Last Synced: 2024-10-13T14:13:40.814Z (6 months ago)
• Topics: api, cloud, hetzner, node, nodejs, wrapper
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/hcloud-js
• Size: 377 KB
• Stars: 52
• Watchers: 3
• Forks: 15
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-hcloud - hcloud-js

README

        
# hcloud-js

[![StandardJS](https://img.shields.io/badge/code--style-standard-yellowgreen.svg?style=flat)](https://standardjs.com)

[![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](LICENSE.md)

[![Documentation Status](https://readthedocs.org/projects/hcloud-js/badge/?version=latest)](http://hcloud-js.readthedocs.io/en/latest/?badge=latest)

[![Travis](https://img.shields.io/travis/dennisbruner/hcloud-js.svg?style=flat)](https://travis-ci.org/dennisbruner/hcloud-js)

[![Known Vulnerabilities](https://snyk.io/test/github/dennisbruner/hcloud-js/badge.svg?targetFile=package.json)](https://snyk.io/test/github/dennisbruner/hcloud-js?targetFile=package.json)

A Node.js module for the Hetzner Cloud API

## Example

### Create a client instance

```javascript

const HetznerCloud = require('hcloud-js')

let client = new HetznerCloud.Client('API_TOKEN')

```

### Build and create a server

```javascript

const { server } = await client.servers.build('my-awesome-server')

  .serverType('cx11')

  .location('nbg1')

  .image('debian-9')

  .sshKey('work')

  .create()

```

## Documentation

 - [hcloud-js documentation page](https://hcloud-js.readthedocs.org/)

 - [Official Hetzner Cloud API documentation](https://docs.hetzner.cloud/)

## Development

### Quick setup

* Clone this repo with `git clone https://github.com/dennisbruner/hcloud-js.git`

* `cd hcloud-js`

* Run `npm install` to install dependencies

* Copy `.env.dist` to `.env` file and setup your access token. [You can use this guide by Hetzner.](https://docs.hetzner.cloud/#getting-started)

## License

[MIT](LICENSE.md)