<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [ibm-cloud-sdk-core](./ibm-cloud-sdk-core.md) &gt; [readCredentialsFile](./ibm-cloud-sdk-core.readcredentialsfile.md)

## readCredentialsFile() function

Return a config object based on a credentials file. Credentials files can be specified filepath via the environment variable: `IBM_CREDENTIALS_FILE`<!-- -->.

**Signature:**

```typescript
export declare function readCredentialsFile(): any;
```
**Returns:**

any