https://github.com/ramsey/uuid-console

A console application for generating UUIDs with ramsey/uuid.
https://github.com/ramsey/uuid-console

console console-tool guid php php7 php8 uuid

Last synced: 6 days ago
JSON representation

A console application for generating UUIDs with ramsey/uuid.

• Host: GitHub
• URL: https://github.com/ramsey/uuid-console
• Owner: ramsey
• License: mit
• Created: 2015-06-22T00:13:56.000Z (over 9 years ago)
• Default Branch: main
• Last Pushed: 2024-07-15T17:55:21.000Z (6 months ago)
• Last Synced: 2024-12-21T10:14:18.276Z (13 days ago)
• Topics: console, console-tool, guid, php, php7, php8, uuid
• Language: PHP
• Homepage:
• Size: 148 KB
• Stars: 39
• Watchers: 4
• Forks: 8
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
ramsey/uuid-console




    A console application for generating UUIDs with ramsey/uuid





    

    

    

    

    

    

    



## About

ramsey/uuid-console is a console application for generating UUIDs with

[ramsey/uuid](https://github.com/ramsey/uuid).

This project adheres to a [code of conduct](CODE_OF_CONDUCT.md).

By participating in this project and its community, you are expected to

uphold this code.

## Installation

Install this package as a dependency using [Composer](https://getcomposer.org).

```bash

composer require ramsey/uuid-console

```

This will install a reference to the console tool in `./vendor/bin/uuid`.

## Usage

If installed in your project, you may execute the console application from the

command line:

    $ ./vendor/bin/uuid

If installed globally using Composer, ensure your global Composer installation

is in your `PATH` (it's usually somewhere like `~/.composer/vendor/bin`). Then,

you may execute it:

    $ uuid

Please be aware that some systems may already have a command line application

named `uuid` installed, so this might create a conflict if anything using your

`PATH` expects the other `uuid` tool.

You can generate UUIDs:

    $ ./vendor/bin/uuid generate

    afe1296a-660b-11e5-bd9f-3c15c2caed47

By default, the application generates version 1 (time-based) UUIDs, but you may

specify other versions:

    $ ./vendor/bin/uuid generate 4

    54478f1d-8b9d-4bf9-8767-1a23010d48a7

You may also decode UUIDs to get information about them:

    $ ./vendor/bin/uuid decode afe1296a-660b-11e5-bd9f-3c15c2caed47

     ========= ========== =========================================

      encode:   STR:       afe1296a-660b-11e5-bd9f-3c15c2caed47

                INT:       233784006064090443909084029429027106119

      decode:   variant:   RFC 4122

                version:   1 (time and node based)

                content:   time:  2015-09-28T18:06:49+00:00

                           clock: 15775 (usually random)

                           node:  3c:15:c2:ca:ed:47

     ========= ========== =========================================

For help, just type `./vendor/bin/uuid` and read the help information.

## Contributing

Contributions are welcome! To contribute, please familiarize yourself with

[CONTRIBUTING.md](CONTRIBUTING.md).

## Coordinated Disclosure

Keeping user information safe and secure is a top priority, and we welcome the

contribution of external security researchers. If you believe you've found a

security issue in software that is maintained in this repository, please read

[SECURITY.md](SECURITY.md) for instructions on submitting a vulnerability report.

## Copyright and License

The ramsey/uuid-console library is copyright © [Ben Ramsey](https://benramsey.com/) and

licensed for use under the MIT License (MIT). Please see [LICENSE](LICENSE) for more

information.