https://github.com/halleck45/oss

Tool for managing Open Source assets
https://github.com/halleck45/oss

Last synced: 2 months ago
JSON representation

Tool for managing Open Source assets

• Host: GitHub
• URL: https://github.com/halleck45/oss
• Owner: Halleck45
• License: mit
• Created: 2015-02-14T15:36:46.000Z (almost 10 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T10:35:09.000Z (10 months ago)
• Last Synced: 2024-06-20T00:31:58.734Z (6 months ago)
• Language: Go
• Size: 2.71 MB
• Stars: 4
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: License

Awesome Lists containing this project

README

        
# OSS

Tool for managing Open Source assets.

## Why ?

Managing Open Source assets is a hard task in any project ; we often download awesome librairies, images or medias, but 

where to keep trace of all theses files ? How can I manage Open Source licenses of medias in my project ? 

That's the problem oss try to resolve today.

![simple overview of oss](./doc/overview.gif)

## Installation

Download the binary for your platform from the [latest release](https://github.com/Halleck45/oss/releases/latest).

## Usage

On first run, please execute

    

```bash

oss init

```

    

Then, you can use the following commands:

+ `oss `**`status`**: list assets of the project

+ `oss `**`add`**`   []`: register new file

+ `oss `**`rm`**` `: unregister file

+ `oss `**`show`**` `: display information about the given file

Or to get information about SPDX licenses :

+ `oss `**`licenses`**: list available licenses (base on the [SPDX license list]((http://spdx.org/licenses/)))

+ `oss `**`search`**` `: Search licenses matching `expression`

+ `oss `**`update`**: update SPDX license list

Keep in mind that **the license identifier should be registered in [SPDX License list](http://spdx.org/licenses/)**

## Copyright

MIT License. Copyright (c) Jean-François Lépine. See LICENSE for details.

## Contributing

Cf. [CONTRIBUTING.md](./.github/CONTRIBUTING.md)

    

Remember to keep tests up to date (and, of course, to run them with `make test`)