shinobi - GitLite

KO | EN

gitlite — search

#ai #typescript #golang #go #machine-learning #rust #nodejs #cli #kubernetes #vue #awesome-list #pytorch #ios #mcp

shinobi

(★ 345)

:japanese_goblin: Simple and light-weight role-based permissions system for Laravel's built in Auth system.

File Explorer

Download Latest Version (.zip)

- shinobi.php
- 2015_01_20_084450_create_roles_table.php
- 2015_01_20_084525_create_role_user_table.php
- 2015_01_24_080208_create_permissions_table.php
- 2015_01_24_080433_create_permission_role_table.php
- 2015_12_04_003040_add_special_role_column.php
- 2017_10_17_170735_create_permission_user_table.php
- - HasPermissions.php
  - HasRoles.php
  - HasRolesAndPermissions.php
  - RefreshesPermissionCache.php
- - Permission.php
  - Role.php
- - PermissionNotFoundException.php
- - Shinobi.php
- - UserHasAllRoles.php
  - UserHasAnyRole.php
  - UserHasRole.php
- - Permission.php
  - Role.php
- - AssignRoleTo.php
  - GivePermissionTo.php
  - RevokePermissionFrom.php
- Shinobi.php
- ShinobiServiceProvider.php
- - PermissionFactory.php
  - RoleFactory.php
  - UserFactory.php
- BladeTest.php
- GrumpyTest.php
- MiddlewareTest.php
- PermissionTest.php
- RoleTest.php
- TestCase.php
- User.php
- UserTest.php
.gitignore
.travis.yml
CHANGELOG.md
composer.json
CONTRIBUTING.md
LICENSE
phpunit.xml
README.md

# Installation Guide

1. Get the code

git clone https://github.com/caffeinated/shinobi

Downloads the entire project code from GitHub to your computer.

cd shinobi

Moves into the project folder you just downloaded.

2. PHP (Composer)

Easy Recommended

Prerequisites

Git Needed to download the project code from GitHub.
PHP A PHP runtime is required.
Composer The package manager used to install PHP libraries.

composer require caffeinated/shinobi

Type this command into your terminal and run it.

✅ Run it with a built-in server like php -S localhost:8000, then open http://localhost:8000 in your browser.

Pulled directly from this repo's README.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# This package has been abandoned and is no longer maintained.

I am unfortunately making the hard decision to archive this package. It's served many of us well over the years, but more and more I've been finding my time stretched thin. As such, I am not able to put in as much focus here in development, documentation, and everything else that goes along with maintaining an open-source package. I can't in good consience leave this as is when so many of you are still using and maybe running in to some issues with things.

As an alternative, I highly recommend Spatie's [laravel-permission](https://github.com/spatie/laravel-permission) package as a replacement. It's nearly a drop-in replacement as both Shinobi and laravel-permission hook in to Laravel's core policies system. The Spatie package is well maintained, has great documentation, and a plethora of configuration options.

If for any reason you'd like to continue or pick up where Shinobi has left off, please feel free to fork and do your thing :v: that's one of the beauty's of open-source.

Thank you for understanding,
Kai

---

# Caffeinated Shinobi
[![Source](https://img.shields.io/badge/source-caffeinated/shinobi-blue.svg?style=flat-square)](https://github.com/caffeinated/shinobi)
[![Latest Stable Version](https://poser.pugx.org/caffeinated/shinobi/v/stable?format=flat-square)](https://packagist.org/packages/caffeinated/shinobi)
[![License](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](https://tldrlegal.com/license/mit-license)
[![Total Downloads](https://img.shields.io/packagist/dt/caffeinated/shinobi.svg?style=flat-square)](https://packagist.org/packages/caffeinated/shinobi)
[![Travis (.org)](https://img.shields.io/travis/caffeinated/shinobi.svg?style=flat-square)](https://travis-ci.org/caffeinated/shinobi)

A simple and light-weight role-based permissions system for Laravel's Authorization Gate system. Originally developed for [FusionCMS](https://github.com/fusioncms/fusioncms), an open source content management system.

- Every user can have zero or more permissions.
- Every user can have zero or more roles.
- Every role can have zero or more permissions.
- Every role can have one of two special flags, `all-access` and `no-access`

## Documentation
You will find user friendly and updated documentation on the [Caffeinated website](https://caffeinatedpackages.com/guide/packages/shinobi.html).

## Installation
Simply install the package through Composer. From here the package will automatically register its service provider and `Shinobi` facade.

```
composer require caffeinated/shinobi
```

### Config
To publish the config file, run the following:

```
php artisan vendor:publish --provider="Caffeinated\Shinobi\ShinobiServiceProvider" --tag="config"
```

## Changelog
You will find a complete changelog history within the [CHANGELOG](CHANGELOG.md) file.

## Contributing
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.

## Testing
Run tests with PHPUnit:

```bash
vendor/bin/phpunit
```

## Security
If you discover any security related issues, please email shea.lewis89@gmail.com directly instead of using the issue tracker.

## Credits
- [Shea Lewis](https://github.com/kaidesu)
- [All Contributors](../../contributors)

## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.