Skip to content

Commit

Permalink
add documentation for setting up an api key
Browse files Browse the repository at this point in the history
  • Loading branch information
Sam-Armstrong committed Oct 12, 2024
1 parent c61c213 commit ca4dff5
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 0 deletions.
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@
:caption: The Basics

overview/get_started.rst
overview/api_key.rst
demos/quickstart.ipynb


Expand Down
18 changes: 18 additions & 0 deletions docs/overview/api_key.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
Setting up your API key
=======================

You can generate a personal api key for Ivy by signing up for free at https://ivy.dev/signin.
This will grant you additional transpilations that can be used for completely free on any code! Find out more at https://ivy.dev/.

Using your API key
------------------

There are two ways to use your api key in your local environment. The easiest is to export it as the IVY_KEY environment variable, like so:

.. code-block:: bash
export IVY_KEY=<my_key>
The other way is to create a 'ivy-key.pem' file in your local directory, containing just your api key. Ivy should automatically detect this file and use your key.

If you run into any problems with your api key, feel free to raise an issue at https://github.com/ivy-llc/ivy/issues, or get in touch at [email protected].

0 comments on commit ca4dff5

Please sign in to comment.