Skip to content

Commit 2501c22

Browse files
committed
Add Corese-Command README.md file
1 parent 1a07852 commit 2501c22

1 file changed

Lines changed: 78 additions & 0 deletions

File tree

README.md

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
# Corese-Command
2+
3+
[![License: CECILL-C](https://img.shields.io/badge/License-CECILL--C-blue.svg)](https://cecill.info/licences/Licence_CeCILL-C_V1-en.html) [![Discussions](https://img.shields.io/badge/Discussions-GitHub-blue)](https://github.com/orgs/corese-stack/discussions)
4+
5+
Corese-Command is the command-line interface (CLI) tool for the Corese platform. It allows users to interact with Corese's RDF processing, SPARQL querying, and reasoning capabilities via the terminal.
6+
7+
## Features
8+
9+
- Convert RDF data formats (Turtle, RDF/XML, N-Triples, etc.).
10+
- Execute SPARQL on a file.
11+
- Validate RDF data with SHACL.
12+
- Execute SPARQL on endpoints.
13+
- Canonicalize RDF data.
14+
15+
## Getting Started
16+
17+
### Download and Install
18+
19+
You can run Corese-Command using Flathub or by downloading and executing the JAR file.
20+
21+
**Flathub:**
22+
23+
To install Corese-Command via Flathub, use the following command:
24+
25+
``` bash
26+
flatpak install flathub fr.inria.corese.CoreseCommand
27+
```
28+
29+
To run the application:
30+
31+
``` bash
32+
flatpak run fr.inria.corese.CoreseCommand
33+
```
34+
35+
For more information, visit the [Flathub page](https://flathub.org/apps/details/fr.inria.corese.CoreseCommand).
36+
37+
**JAR File:**
38+
39+
Download the latest version of the Corese-Command JAR from the [releases page](https://github.com/corese-stack/corese-command/releases) and run it with the following command:
40+
41+
``` bash
42+
java -jar corese-command-4.5.0.jar
43+
```
44+
45+
This will provide you with access to the Corese-Command interface.
46+
47+
## Usage
48+
49+
For a full list of available commands and options, use:
50+
51+
``` bash
52+
java -jar corese-command-4.5.0.jar --help
53+
```
54+
55+
> Create an alias for the JAR file to simplify the command `echo 'alias corese="java -jar path/to/corese-command-4.5.0.jar"' >> ~/.bashrc`
56+
> After that, you can directly use the `corese` command to run Corese-Command.
57+
> For example, `corese --help`.
58+
59+
## Documentation
60+
61+
For more information on using Corese-Command, please refer to the following resources:
62+
63+
- [Getting Started Guide](https://corese-stack.github.io/corese-command/v4.5.0/getting_started/getting_started_with_corese-command.html)
64+
- [API Documentation](https://corese-stack.github.io/corese-command/v4.5.0/java_api/library_root.html)
65+
66+
## Contributions and Community
67+
68+
We welcome contributions to improve Corese-Command! Here’s how you can get involved:
69+
70+
- **Discussions:** If you have questions, ideas, or suggestions, please participate in our [discussion forum](https://github.com/orgs/corese-stack/discussions).
71+
- **Issue Tracker:** Found a bug or want to request a new feature? Use our [issue tracker](https://github.com/corese-stack/corese-command/issues).
72+
- **Pull Requests:** We accept pull requests. You can submit your changes [here](https://github.com/corese-stack/corese-command/pulls).
73+
74+
## Useful Links
75+
76+
- [Corese Official Website](https://corese-stack.github.io/corese-command/v4.5.0/index.html)
77+
- **Mailing List:** <corese-users@inria.fr>
78+
- **Join the Mailing List:** Send an email to <corese-users-request@inria.fr> with the subject: `subscribe`

0 commit comments

Comments
 (0)