2015-02-05 20:36:30 +00:00
## Ethereum Go
2015-02-05 20:34:47 +00:00
Ethereum Go Client © 2014 Jeffrey Wilcke.
2015-02-20 17:13:39 +00:00
| Linux | OSX | Windows | Tests
----------|---------|-----|---------|------
2015-04-21 10:38:01 +00:00
develop | [](https://build.ethdev.com/builders/Linux%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/OSX%20Go%20develop%20branch/builds/-1) | [](https://build.ethdev.com/builders/Windows%20Go%20develop%20branch/builds/-1) | [](https://travis-ci.org/ethereum/go-ethereum) [](https://coveralls.io/r/ethereum/go-ethereum?branch=develop)
master | [](https://build.ethdev.com/builders/Linux%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/OSX%20Go%20master%20branch/builds/-1) | [](https://build.ethdev.com/builders/Windows%20Go%20master%20branch/builds/-1) | [](https://travis-ci.org/ethereum/go-ethereum) [](https://coveralls.io/r/ethereum/go-ethereum?branch=master)
2015-02-05 20:34:47 +00:00
2014-10-27 16:22:29 +00:00
[](https://waffle.io/ethereum/go-ethereum)
2014-10-22 21:56:40 +00:00
[](https://waffle.io/ethereum/go-ethereum)
2015-01-24 18:09:29 +00:00
[](http://waffle.io/ethereum/go-ethereum)
[](https://gitter.im/ethereum/go-ethereum?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
2015-01-24 17:48:19 +00:00
2014-10-27 16:14:37 +00:00
2014-10-27 16:22:29 +00:00
Build
=====
2015-01-24 18:09:29 +00:00
Mist (GUI):
2014-10-27 16:22:29 +00:00
`go get github.com/ethereum/go-ethereum/cmd/mist`
2015-03-26 21:48:24 +00:00
Geth (CLI):
2014-10-27 16:22:29 +00:00
2015-03-27 23:32:23 +00:00
`go get github.com/ethereum/go-ethereum/cmd/geth`
2014-10-27 16:22:29 +00:00
2015-03-20 12:19:26 +00:00
As of POC-8, go-ethereum uses [Godep ](https://github.com/tools/godep ) to manage dependencies. Assuming you have [your environment all set up ](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum ), switch to the go-ethereum repository root folder, and build/install the executable you need:
2015-03-02 18:44:29 +00:00
Mist (GUI):
```
godep go build -v ./cmd/mist
```
2015-03-26 21:48:24 +00:00
Geth (CLI):
2015-03-02 18:44:29 +00:00
```
2015-03-26 21:48:24 +00:00
godep go build -v ./cmd/geth
2015-03-02 18:44:29 +00:00
```
Instead of `build` , you can use `install` which will also install the resulting binary.
2015-04-20 20:47:12 +00:00
For prerequisites and detailed build instructions please see the [Wiki ](https://github.com/ethereum/go-ethereum/wiki/Building-Ethereum )
2015-03-02 18:44:29 +00:00
If you intend to develop on go-ethereum, check the [Developers' Guide ](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide )
2014-10-27 16:22:29 +00:00
2014-10-27 16:24:43 +00:00
Automated (dev) builds
======================
2015-03-15 11:19:26 +00:00
* [Docker ](https://registry.hub.docker.com/u/ethereum/client-go/ )
* [OS X ](http://build.ethdev.com/builds/OSX%20Go%20develop%20branch/Mist-OSX-latest.dmg )
* Ubuntu
2015-04-13 21:09:23 +00:00
[trusty ](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-trusty/latest/ ) |
[utopic ](https://build.ethdev.com/builds/Linux%20Go%20develop%20deb%20i386-utopic/latest/ )
2014-10-27 16:24:43 +00:00
* [Windows] Coming soon™
2014-10-27 16:22:29 +00:00
2015-03-02 18:44:29 +00:00
Executables
===========
2014-02-14 23:04:46 +00:00
2015-03-02 18:44:29 +00:00
Go Ethereum comes with several wrappers/executables found in
[the `cmd` directory ](https://github.com/ethereum/go-ethereum/tree/develop/cmd ):
2014-11-18 19:23:17 +00:00
2015-03-02 18:44:29 +00:00
* `mist` Official Ethereum Browser (ethereum GUI client)
2015-03-26 21:48:24 +00:00
* `geth` Ethereum CLI (ethereum command line interface client)
2015-03-02 18:44:29 +00:00
* `bootnode` runs a bootstrap node for the Discovery Protocol
* `ethtest` test tool which runs with the [tests ](https://github.com/ethereum/testes ) suite:
2015-01-22 21:42:39 +00:00
`cat file | ethtest` .
2014-11-18 19:23:17 +00:00
* `evm` is a generic Ethereum Virtual Machine: `evm -code 60ff60ff -gas
10000 -price 0 -dump`. See `-h` for a detailed description.
2015-01-30 13:41:14 +00:00
* `disasm` disassembles EVM code: `echo "6001" | disasm`
2015-03-02 18:44:29 +00:00
* `rlpdump` converts a rlp stream to `interface{}` .
2014-02-15 12:27:23 +00:00
2015-03-02 18:44:29 +00:00
Command line options
2014-10-27 16:22:29 +00:00
============================
2013-12-26 12:29:45 +00:00
2015-03-26 21:48:24 +00:00
Both `mist` and `geth` can be configured via command line options, environment variables and config files.
2015-03-02 18:44:29 +00:00
To get the options available:
2014-01-16 10:00:56 +00:00
```
2015-03-26 21:48:24 +00:00
geth -help
2014-02-08 21:16:11 +00:00
```
2015-03-02 18:44:29 +00:00
For further details on options, see the [wiki ](https://github.com/ethereum/go-ethereum/wiki/Command-Line-Options )
2014-01-11 14:27:08 +00:00
Contribution
============
2015-03-02 18:44:29 +00:00
If you'd like to contribute to go-ethereum please fork, fix, commit and
2014-02-14 23:04:46 +00:00
send a pull request. Commits who do not comply with the coding standards
2014-08-21 13:27:01 +00:00
are ignored (use gofmt!). If you send pull requests make absolute sure that you
2014-02-15 10:49:39 +00:00
commit on the `develop` branch and that you do not merge to master.
Commits that are directly based on master are simply ignored.
2014-02-15 10:49:29 +00:00
2015-04-23 18:05:37 +00:00
See [Developers' Guide ](https://github.com/ethereum/go-ethereum/wiki/Developers'-Guide ) for more details on configuring your environment, testing, and dependency management.
2014-01-11 14:41:05 +00:00
