| --- |
| title: Getting Started |
| sidebar_position: 1 |
| id: getting-started |
| license: | |
| Licensed to the Apache Software Foundation (ASF) under one or more |
| contributor license agreements. See the NOTICE file distributed with |
| this work for additional information regarding copyright ownership. |
| The ASF licenses this file to You under the Apache License, Version 2.0 |
| (the "License"); you may not use this file except in compliance with |
| the License. You may obtain a copy of the License at |
| |
| http://www.apache.org/licenses/LICENSE-2.0 |
| |
| 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. |
| --- |
| |
| This guide covers installation, usage, and integration of the Fory IDL compiler. |
| |
| ## Installation |
| |
| ### From Source |
| |
| ```bash |
| cd compiler |
| pip install -e . |
| ``` |
| |
| ### Verify Installation |
| |
| ```bash |
| foryc --help |
| ``` |
| |
| ## First generation |
| |
| ```bash |
| foryc example.fdl --lang java,python --output ./generated |
| ``` |
| |
| Continue with the [CLI reference](cli.md) for frontend and output options or |
| [Build Integration](build-integration.md) to run generation from the application build. |