Shard Detail

avram v1.0.0-rc1

A Crystal database wrapper for reading, writing, and migrating Postgres databases.

Install & Use

Add the following code to your project's shard.yml under:

dependencies to use in production
- OR -
development_dependencies to use in development

  github: luckyframework/avram



API Documentation Website

Why Avram?

The name comes from Henriette Avram.

Henriette Davidson Avram (October 7, 1919 – April 22, 2006) was a computer programmer and systems analyst who developed the MARC format (Machine Readable Cataloging), the international data standard for bibliographic and holdings information in libraries.


Add this to your application's shard.yml:

    github: luckyframework/avram


require "avram"


  1. Fork it ( )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Install docker and docker-compose:
  4. Run script/setup
  5. Make your changes
  6. Run script/test to run the specs, build shards, and check formatting
  7. Commit your changes (git commit -am 'Add some feature')
  8. Push to the branch (git push origin my-new-feature)
  9. Create a new Pull Request


To run the tests:

  1. Install docker and docker-compose:
  2. Run script/setup to set up the docker environment
  3. Run script/test to run the specs, build shards, and check formatting

You can run individual tests like this: docker-compose run --rm app crystal spec path/to/

Remember to run docker-compose down when you're done. This will stop the Crystal container.