From e160f7362c414e530fa7235f4e7fe8d15354801d Mon Sep 17 00:00:00 2001 From: Devin Logan Date: Tue, 8 Jul 2025 11:23:56 -0400 Subject: [PATCH] add ruby quickstart --- .../sdks/overview/ruby/quickstart.mdx | 85 ++++++++++++++++++- 1 file changed, 83 insertions(+), 2 deletions(-) diff --git a/fern/products/sdks/overview/ruby/quickstart.mdx b/fern/products/sdks/overview/ruby/quickstart.mdx index 747074a03..8d9962e50 100644 --- a/fern/products/sdks/overview/ruby/quickstart.mdx +++ b/fern/products/sdks/overview/ruby/quickstart.mdx @@ -3,6 +3,87 @@ title: Ruby Quickstart description: Get started quickly with the Fern Ruby SDK. --- -# Ruby Quickstart + -Follow these steps to quickly get up and running with the Fern Ruby SDK. \ No newline at end of file +Generate a Ruby SDK by following the instructions on this page. + + + + + ### Initialize the Fern Folder + + You can use either the OpenAPI definition, AsyncAPI definition, or Fern + Definition to generate your SDK. + + + + + + + + + + + 2. Add the config option `outputSourceFiles: true` to + `generators.yml`. This ensures your SDK contains source files in + your preferred SDK language instead of compiled output. + + ```yaml {11-12} + # yaml-language-server: $schema=https://schema.buildwithfern.dev/generators-yml.json + default-group: local + groups: + local: + generators: + - name: fernapi/fern-typescript-sdk + output: + location: local-file-system + path: ../sdks/typescript + version: + config: + outputSourceFiles: true + ``` + + `fern init` creates a default configuration that includes the + TypeScript Node SDK generator. The `local` group containing this + generator only generates if you run fern generate without specifying a + group, or if you explicitly target it with `fern generate --group + local`. In subsequent steps, you'll add an additional generator for your + preferred SDK language. + + + + + + +### Add the SDK generator + +Add the Ruby SDK generator: + +```bash +fern add fern-ruby-sdk --group sdk +``` + +This command adds the following to `generators.yml`: + +```yaml + sdk: + generators: + - name: fernapi/fern-ruby-sdk + version: + output: + location: local-file-system + path: ../sdks/ruby +``` + + + +```bash +fern/ # created in step 1 +sdks/ # created by fern generate --group sdk +├─ ruby + ├─ YourOrganization_api_client.gemspec + ├─ test/ + └─ lib/ + └─ YourOrganization_api_client/ +``` +