Skip to content
Open Source implementation of the Accord Project Template Specification
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.travis Use pkgset rather than pkgbump in release script (#229) Oct 29, 2018
packages
scripts Engine refactor (#319) Mar 20, 2019
.gitignore
.travis.yml (fix) Only run coverage on main repo, not on forks Jan 30, 2019
CONTRIBUTING.md (chore): Update CONTRIBUTING.md Aug 9, 2018
DEVELOPERS.md
LICENSE
README.md (chore) Add npm version badge Jan 28, 2019
cicero.png adds logo Dec 13, 2018
jsdoc.json debugging readthedocs Feb 6, 2018
lerna.json
markdown-license.txt
package-lock.json
package.json Automatic version bump to 0.11.1 Mar 21, 2019

README.md

Cicero

Build Status Coverage Status lerna npm version

Introduction

Cicero allows you to define natural language contract and clause templates that can be executed by a computer. These could be relatively simple things like if the goods are more than [{DAYS}] late, then notify the supplier of the goods, with the message [{MESSAGE}]. or more elaborate natural language and logic such as computing interest on a loan, or calculating penalties based on IoT sensor readings.

You can browse the library of Open Source Cicero contract and clause templates at: https://templates.accordproject.org.

Cicero is an Open Source implementation of the Accord Project Template Specification. It defines the structure of natural language templates, bound to a data model, that can be executed using request/response JSON messages.

You can read the latest user documentation here: http://docs.accordproject.org.

Smart Clause™

Using Cicero you can take any existing natural language text (typically a clause or a contract) and declaratively bind it to a data model. Cicero generates a parser (using the Earley parser algorithm) to parse and validate source text, extracting machine readable/computable data. The Cicero engine can then be used to execute a Smart Clause™ (an instance of a template) against a JSON payload. Smart Clause™ software can be used to add computable functionality to any document. Clauses are typically stateless (idempotent) functions. They receive an incoming request and the template data, and they produce a response.

Get Involved!

We are an open community and welcome both lawyers and technologists to work on the specifications and code. If you would like to get involved please join the Accord #technology-wg Slack channel by signing up here: https://www.accordproject.org.

Accord Technology Working Group weekly meeting

Structure of the Code Repository

Top level repository (cicero), with sub packages. Each sub-package is published as an independent npm module using lerna:

  • cicero-core : Template and Clause classes to manage the grammar, models and logic.
  • cicero-engine : A Node.js VM based execution engine
  • cicero-cli : Command line utility for testing
  • generator-cicero-template: Utility to generate a new template

License

Accord Project source code files are made available under the Apache License, Version 2.0 (Apache-2.0), located in the LICENSE file. Accord Project documentation files are made available under the Creative Commons Attribution 4.0 International License (CC-BY-4.0), available at http://creativecommons.org/licenses/by/4.0/.

© 2017-2019 Clause, Inc.

You can’t perform that action at this time.