2016-01-22 12:22:54 +00:00
|
|
|
# ipfs-key
|
2016-12-20 11:52:00 +00:00
|
|
|
|
|
|
|
|
[](https://github.com/RichardLitt/standard-readme)
|
|
|
|
|
|
|
|
|
|
> A tool for easily generating ipfs keypairs
|
|
|
|
|
|
|
|
|
|
## Table of Contents
|
|
|
|
|
|
|
|
|
|
- [Installation](#installation)
|
|
|
|
|
- [Usage](#usage)
|
|
|
|
|
- [Contribute](#contribute)
|
|
|
|
|
- [License](#license)
|
2016-01-22 12:22:54 +00:00
|
|
|
|
|
|
|
|
## Installation
|
2016-12-20 11:52:00 +00:00
|
|
|
|
2016-12-23 19:53:54 +00:00
|
|
|
You need go, gx and gx-go installed as a prerequisite. See http://github.com/ipfs/go-ipfs/ on how to install these.
|
|
|
|
|
|
2016-01-22 12:22:54 +00:00
|
|
|
```
|
2016-12-23 19:53:54 +00:00
|
|
|
$ go get -d github.com/whyrusleeping/ipfs-key
|
|
|
|
|
$ gx install
|
2016-01-22 12:22:54 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Usage
|
2016-12-20 11:52:00 +00:00
|
|
|
|
|
|
|
|
When run, it will write the bytes of
|
|
|
|
|
the serialized private key to stdout. By default, a 2048 bit RSA key will be
|
|
|
|
|
generated. In this case the key size can be changed by specifying the `-bitsize`
|
|
|
|
|
option. The key type can be changed by specifying the `-type` option (rsa or
|
2016-12-20 19:41:10 +00:00
|
|
|
ed25519).
|
2016-12-20 11:52:00 +00:00
|
|
|
|
2016-01-22 12:22:54 +00:00
|
|
|
```
|
2016-12-20 11:52:00 +00:00
|
|
|
$ ipfs-key -bitsize=4096 > my-rsa4096.key
|
|
|
|
|
$ ipfs-key -type=ed25519 > my-ed.key
|
2016-01-22 12:22:54 +00:00
|
|
|
```
|
2016-12-20 11:52:00 +00:00
|
|
|
|
|
|
|
|
## Contribute
|
|
|
|
|
|
|
|
|
|
PRs accepted.
|
|
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
2016-12-20 19:41:10 +00:00
|
|
|
[MIT](LICENSE) Copyright (c) 2016 [Jeromy Johnson](http://github.com/whyrusleeping)
|
