2.8 KiB

Crystal CI

This project is inspired by Ruby's mechanize. The purpose is to cover all the features of original one.

API Documentation


  1. Add the dependency to your shard.yml:

        github: Kanezoh/
  2. Run shards install


GET request

require "mechanize"

agent =
page = agent.get("")

puts page.code # => 200
puts page.body # => html
puts page.title # => Example Domain

POST request

You can also send post request with data.

require "mechanize"

agent =
query = {"foo" => "foo_value", "bar" => "bar_value"}
page ="", query: query)
# => request body is foo=foo_value&bar=bar_value

add query params, request_headers

You can add any query parameters and headers to requests.

require "mechanize"

agent =
agent.request_headers = HTTP::Headers{"Foo" => "Bar"}
params = {"hoge" => "hoge"}
page = agent.get("", params: params)
# The actual URL is

fill and submit form

You can fill and submit form by using field_with and submit. It enables you to scrape web pages requiring login.

require "mechanize"

agent =
page = agent.get("#{web page contains login form}")
form = page.forms[0]
form.field_with("email").value = ""
form.field_with("password").value = "xxxxxx"

agent.get("#{web page only logged-in users can see}"

search node

You can use css selector to search html nodes by using #css method. This method is from lexbor, so if you want to explore more, please refer the repository.

puts page.css("h1").first.inner_text


For activation, simply setup the log to :debug level

Log.setup("mechanize", :debug)

Basic auth

You can access a page which is protected by basic auth, setting username and password for the url.

agent =
agent.add_auth("", "username", "password")


  1. Fork it (
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request