This README is the one indexed from the repository at its latest ref, not from the tag for this version.

Libcrown

Library for Unix users, groups and passwords manipulation.

Can be used to perform actions in Crystal usually done by commands like adduser, deluser.

Warning

By essence, manipulating system users, groups and passwords is sensitive. Be careful and be sure of what you do before any action.

This library is provided "as is", with no warranties, as stated in the ISC LICENSE.

Installation

Add the dependency to your shard.yml:

dependencies:
  libcrown:
    github: j8r/libcrown

Documentation

https://j8r.github.io/libcrown

Usage

To add a new user

require "libcrown"

# Root permissions are needed
libcrown = Libcrown.new

# Add a new group
libcrown.add_group Libcrown::Group.new("new_group"), 100_u32

# Add a new user with `new_group` as its main group
new_user = Libcrown::User.new(
  name:           "new_user",
  gid:            100_u32,
  full_name:      "New Usser",
  home_directory: "/home/new_user",
  login_shell:    "/bin/sh",
)
libcrown.add_user new_user

# Save the modifications to the disk
libcrown.write

License

Copyright (c) 2018-2019 Julien Reichardt - ISC License