{"id":23333890,"url":"https://github.com/schultyy/niman","last_synced_at":"2025-08-04T23:11:27.999Z","repository":{"id":26807167,"uuid":"30265658","full_name":"schultyy/Niman","owner":"schultyy","description":"Provisions your machine","archived":false,"fork":false,"pushed_at":"2015-04-03T17:43:25.000Z","size":621,"stargazers_count":1,"open_issues_count":5,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-20T09:59:15.209Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/schultyy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2015-02-03T21:32:23.000Z","updated_at":"2015-10-20T19:07:53.000Z","dependencies_parsed_at":"2022-06-27T10:27:21.614Z","dependency_job_id":null,"html_url":"https://github.com/schultyy/Niman","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"purl":"pkg:github/schultyy/Niman","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schultyy%2FNiman","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schultyy%2FNiman/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schultyy%2FNiman/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schultyy%2FNiman/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/schultyy","download_url":"https://codeload.github.com/schultyy/Niman/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/schultyy%2FNiman/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267093851,"owners_count":24034953,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-12-21T00:32:49.689Z","updated_at":"2025-07-26T00:34:41.673Z","avatar_url":"https://github.com/schultyy.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Niman\n[![Build Status](https://travis-ci.org/schultyy/Niman.svg?branch=master)](https://travis-ci.org/schultyy/Niman)\n[![Code Climate](https://codeclimate.com/github/schultyy/Niman/badges/gpa.svg)](https://codeclimate.com/github/schultyy/Niman)\n\nNiman is a proof-of-concept provisioner.\n\n## Installation\n\nAdd this line to your application's Gemfile:\n\n```ruby\ngem 'niman'\n```\n\nAnd then execute:\n\n    $ bundle\n\nOr install it yourself as:\n\n    $ gem install niman\n\n## Usage\n\nIt starts with a `Nimanfile`:\n\n```ruby\nNiman::Recipe.configure do |config|\n  config.file '/home/bob/hello.txt' do |file|\n    file.content = 'hello from alice'\n  end\nend\n```\nThis places a new file `hello.txt` in `/home/bob` with rights 0600.\n\nA `Nimanfile` contains all necessary commands for `niman` to run.\n\n### Commands\n\nNiman has support to execute arbitrary commands on the host system:\n\n```ruby\nNiman::Recipe.configure do |config|\n  config.exec \"touch ~/hello.txt\"\nend\n```\n\nOr if you need sudo privileges:\n\n```ruby\nNiman::Recipe.configure do |config|\n  config.exec :sudo, \"apt-get update\"\nend\n```\n\n### Packages\n\nUse a concrete package in your script:\n\n```ruby\nNiman::Recipe.configure do |config|\n  config.package do |package|\n    package.name = \"vim\"\n  end\nend\n```\n\n#### Custom packages\n\nCustom packages live in `packages/`. Every package gets its own file.\n\nPackage description:\n```ruby\n#packages/ruby.rb\nrequire 'niman'\nclass RubyPackage \u003c Niman::Library::CustomPackage\n  package_name :ubuntu, \"ruby1.9.1\"\n  package_name :centos, \"ruby1.9.1\"\nend\n```\n\nIn your `Nimanfile`:\n\n```ruby\nNiman::Recipe.configure do |config|\n  config.package \"packages/ruby\"\nend\n```\n\nA custom package can have one or more configuration files inside of it:\n\n```ruby\n#packages/nginx\nclass NginxPackage \u003c Niman::Library::CustomPackage\n  package_name :ubuntu, 'nginx'\n  \n  file '/etc/nginx/nginx.conf' do |config|\n    #general nginx configuration goes here\n    config.content = '...'\n  end\n  \n  file '/etc/nginx/sites-available/example.com' do |config|\n    config.content = '...'\n  end\nend\n```\n\nA custom package can also be used as a container for a bunch of configuration files\nand shell commands without the need to specify `package_names`:\n\n```ruby\n#packages/ruby\nrequire 'niman'\nclass RubyPackage \u003c Niman::Library::CustomPackage\n  exec '\\\\curl -sSL https://get.rvm.io | bash -s stable'\n  exec 'rvm install ruby --latest'\nend\n```\n\n### Apply `Nimanfile`\n\nTo apply a `Nimanfile` run:\n\n```bash\n$ niman apply\n```\n\n### Use it as a Vagrant plugin\n\nAt first, install it as Vagrant plugin:\n```bash\n$ vagrant plugin install niman\n```\n\nThen, in `Vagrantfile`, add this line:\n\n```ruby\nconfig.vm.provision \"niman\"\n```\nSave the file and after this you can `vagrant provision`.\n\n## Contributing\n\n1. Fork it ( https://github.com/[my-github-username]/niman/fork )\n2. Create your feature branch (`git checkout -b my-new-feature`)\n3. Commit your changes (`git commit -am 'Add some feature'`)\n4. Push to the branch (`git push origin my-new-feature`)\n5. Create a new Pull Request\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschultyy%2Fniman","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fschultyy%2Fniman","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fschultyy%2Fniman/lists"}