A tool to download, build, and assemble application dependencies.
Brought to you by the Clam AntiVirus Team.
Copyright (C) 2019-2021 Cisco Systems, Inc. and/or its affiliates. All rights reserved.
Mussels is a cross-platform and general-purpose dependency build automation tool.
Mussels helps automate the building of applications and their versioned dependency chains using the original build systems intended by the software authors.
For a more in depth explanation, see the Mussels Introduction.
- Python 3.6 or newer.
- Git (must be added to your PATH environment variable).
An internet connection is required to use the public Mussels cookbooks. Some form of internet or intranet is required to download source archives from the URLs defined in each recipe.
Every recipe will require tools in order to run. If you don't have the required tools, you'll get an error message stating that you're missing a required tool. It will be up to you to install the tool in order for that recipe to build.
Common Tools Requirements for building C/C++ software
Mussels was born out of the ClamAV project so you can find some good example recipe and tool definitions here: https://github.com/Cisco-Talos/clamav-mussels-cookbook/
The ClamAV recipes build C libraries for the most part. When using them, you'll probably the following compiler toolchain software installed on your system for the build to work. If these are missing, the Mussels build will fail and tell you as much.
- Clang (comes with XCode)
- Visual Studio 2017+
You may install Mussels from PyPI using
pip, or you may clone the Mussels Git repository and use
pip to install it locally.
Install Mussels from PyPI:
python3 -m pip install --user mussels
--help option to get information about any Mussels command.
mussels build --help
When performing a build, the intermediate build files are placed into the
~/.mussels/cache/work/<target> directory and the final installed files into the
~/.mussels/install/<target> directory. This default behavior can be overridden using
msl build --work-dir <path> to specify a different work directory, and
msl build --install <path> to specify a different install directory.
Tip: Use the
msl shortcut, instead of
mussels to save keystrokes.
Tip: You may not be able to run
mussels or the
msl shortcut directly if your Python Scripts directory is not in your
PATH environment variable. If you run into this issue, and do not wish to add the Python Scripts directory to your path, you can run Mussels like this:
python -m mussels
Learn more about how use Mussels in our documentation.
Mussels is open source and we'd love your help. There are many ways to contribute!
Join the Mussels community on the Mussels Discord chat server.
You can contribute to the Mussels community by creating new recipes or improving on existing recipes in the "scrapbook". Do this by submitting a pull request to that Git repository.
If your project is willing to make your project-specific recipes available to the public, we'd also be happy to add your cookbook repository to the Mussels bookshelf. Do this submitting a pull request to this Git repository. As noted above, each cookbook's license must be compatible with the Apache v2.0 license used by Mussels in order to be included in the bookshelf.
To learn more about how to read & write Mussels recipe and tool definitions, check out the following:
If you find an issue with Mussels or the Mussels documentation, please submit an issue to our GitHub issue tracker. Before you submit, please check to if someone else has already reported the issue.
If you find a bug and you're able to craft a fix yourself, consider submitting the fix in a pull request. Your help will be greatly appreciated.
If you want to contribute to the project and don't have anything specific in mind, please check out our issue tracker. Perhaps you'll be able to fix a bug or add a cool new feature.
By submitting a contribution to the Mussels project, you acknowledge and agree to assign Cisco Systems, Inc the copyright for the contribution. If you submit a significant contribution such as a new feature or capability or a large amount of code, you may be asked to sign a contributors license agreement comfirming that Cisco will have copyright license and patent license and that you are authorized to contribute the code.
Mussels Development Set-up
The following steps are intended to help users that wish to contribute to development of the Mussels project get started.
Create a fork of the Mussels git repository, and then clone your fork to a local directory.
git clone https://github.com/<your username>/Mussels.git
Make user Mussels is not already installed. If it is, remove it.
python3 -m pip uninstall mussels
Use pip to install Mussels in "edit" mode.
python3 -m pip install -e --user ./Mussels
Once installed in "edit" mode, any changes you make to your clone of the Mussels code will be immediately usable simply by running the
This project has not selected a specific Code-of-Conduct document at this time. However, contributors are expected to behave in professional and respectful manner. Disrespectful or inappropriate behavior will not be tolerated.
Mussels is licensed under the Apache License, Version 2.0 (the "License"). You may not use the Mussels project except in compliance with the License.
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.